CustomFields.ReadCustomFields method

  • Article

Gets enterprise custom field definitions.

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

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/CustomFields/ReadCustomFields", RequestNamespace := "https://schemas.microsoft.com/office/project/server/webservices/CustomFields/",  _
    ResponseNamespace := "https://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("https://schemas.microsoft.com/office/project/server/webservices/CustomFields/ReadCustomFields", RequestNamespace = "https://schemas.microsoft.com/office/project/server/webservices/CustomFields/", 
    ResponseNamespace = "https://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.

  • 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.

Note

For Project Server 2010, the returned CustomFieldDataSet can include the Relative Importance custom field and the Project Impact custom fields. Project Web App does not show these custom fields in the Enterprise Custom Fields and Lookup Tables page, because they are built-in for portfolio analyses and cannot be modified or deleted.

Tip

The ReadCustomFields method ignores the locale setting of the computer running Project Server. The ReadCustomFields2 method returns locale-dependent values for formulas that calculate custom fields and graphical indicators.

For a code example that uses the ReadCustomFields2 method, see ReadCustomFields2. For more information, see How to: Use a Filter Parameter with PSI Methods

Project Server Permissions

Permission

Description

LogOnToProjectServerFromProjectProfessional

Allows a user to connect to the Project Server database from Project Professional. Global permission.

ManageEnterpriseCustomFields

Allows a user to modify the definitions of enterprise custom fields and lookup table values. Global permission.

ManageUsersAndGroups

Allows a user to manage Project Server users and groups. Global permission.

NewProject

Allows a user to create a project. Global permission.

ViewResourceCenter

Allows a user to view resource allocation data. Global permission.

See also

Reference

CustomFields class

CustomFields members

WebSvcCustomFields namespace

ReadCustomFields2(String, Boolean)

Other resources

How to: Use a Filter Parameter with PSI Methods