CustomFields.ReadCustomFields Method

Gets enterprise custom field definitions.

Namespace:  WebSvcCustomFields
Assembly:  ProjectServerWebServices (in ProjectServerWebServices.dll)

Syntax

'Declaration
<SoapDocumentMethodAttribute("http://schemas.microsoft.com/office/project/server/webservices/CustomFields/ReadCustomFields", RequestNamespace := "http://schemas.microsoft.com/office/project/server/webservices/CustomFields/",  _
    ResponseNamespace := "http://schemas.microsoft.com/office/project/server/webservices/CustomFields/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function ReadCustomFields ( _
    xmlFilter As String, _
    autoCheckOut As Boolean _
) As CustomFieldDataSet

'Usage
Dim instance As CustomFields
Dim xmlFilter As String
Dim autoCheckOut As Boolean
Dim returnValue As CustomFieldDataSet

returnValue = instance.ReadCustomFields(xmlFilter, _
    autoCheckOut)

[SoapDocumentMethodAttribute("http://schemas.microsoft.com/office/project/server/webservices/CustomFields/ReadCustomFields", RequestNamespace = "http://schemas.microsoft.com/office/project/server/webservices/CustomFields/", 
    ResponseNamespace = "http://schemas.microsoft.com/office/project/server/webservices/CustomFields/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public CustomFieldDataSet ReadCustomFields(
    string xmlFilter,
    bool autoCheckOut
)

Parameters

• xmlFilter
  Type: System.String
  Limits the amount of data returned. For more information, see How to: Use a Filter Parameter with PSI Methods.

• autoCheckOut
  Type: System.Boolean
  If true, check out the custom fields for modification.

Return Value

Type: WebSvcCustomFields.CustomFieldDataSet
The CustomFieldDataSet contains information specified by the xmlFilter parameter.

Remarks

The primary DataTable in the CustomFieldDataSet is the CustomFieldsDataTable. There are no secondary datatables. The xmlFilter parameter works with the Criteria operators to filter rows in the CustomFieldsDataTable.

You can use the Fields.Add method to filter columns in the primary CustomFieldsDataTable.

Project Server Permissions

Permission	Description
CreateNewProposalOrActivity	Create a new proposal. Global permission.
LogOnToProjectServerFromProjectProfessional	Connect to the Project Server database from Project Professional. Global permission.
ManageEnterpriseCustomFields	Modify the definitions of enterprise custom fields and lookup table values. Global permission.
ManageUsersAndGroups	Manage Project Server users and groups. Global permission.
ViewResourceCenter	View resource allocation data. Global permission.

See Also

Reference

CustomFields Class

CustomFields Members

WebSvcCustomFields Namespace

Other Resources

How to: Use a Filter Parameter with PSI Methods