Project.ReadProjectSyncSettings method

Retrieves the synchronization data for a set of projects or SharePoint task lists that are synchronized.

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

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/Project/ReadProjectSyncSettings", RequestNamespace := "https://schemas.microsoft.com/office/project/server/webservices/Project/",  _
    ResponseNamespace := "https://schemas.microsoft.com/office/project/server/webservices/Project/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function ReadProjectSyncSettings ( _
    syncEntityUids As Guid(), _
    syncEntityUidType As SyncEntityUidType, _
    includeMappingData As Boolean _
) As SyncDataSet
'Usage
Dim instance As Project
Dim syncEntityUids As Guid()
Dim syncEntityUidType As SyncEntityUidType
Dim includeMappingData As Boolean
Dim returnValue As SyncDataSet

returnValue = instance.ReadProjectSyncSettings(syncEntityUids, _
    syncEntityUidType, includeMappingData)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/office/project/server/webservices/Project/ReadProjectSyncSettings", RequestNamespace = "https://schemas.microsoft.com/office/project/server/webservices/Project/", 
    ResponseNamespace = "https://schemas.microsoft.com/office/project/server/webservices/Project/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public SyncDataSet ReadProjectSyncSettings(
    Guid[] syncEntityUids,
    SyncEntityUidType syncEntityUidType,
    bool includeMappingData
)

Parameters

• syncEntityUids
  Type: []

  The GUIDs of the projects or SharePoint task lists that have been synchronized.

• syncEntityUidType
  Type: WebSvcProject.SyncEntityUidType

  Specifies whether to read the synchronization settings for a set of projects or SharePoint task lists.

• includeMappingData
  Type: System.Boolean

  Specifies whether to include synchronization mapping data.

Return value

Type: WebSvcProject.SyncDataSet
Contains the synchronization settings for each synchronized project or SharePoint task list.

Remarks

This is a new method in Project Server 2013. The ReadProjectSyncSettings method requires that the projects or SharePoint task lists that are specified by syncEntityUids have already been synchronized by the CreateWssListSyncedProject method or the SyncProjectWithWss method. For a code sample that includes the ReadProjectSyncSettings method, see UpdateProjectSyncSettings.

Project Server Permissions

Permission	Description
PublishProject	Allows a user to publish a project to the Project Server Published database.

See also

Reference

Project class

Project members

WebSvcProject namespace