This documentation is archived and is not being maintained.

CrmOutlookService.Sync Method

Dynamics
banner art

[Applies to: Microsoft Dynamics CRM 4.0]

Find the latest SDK documentation: CRM 2015 SDK

Triggers a synchronization event between Microsoft Dynamics CRM for Outlook and the Microsoft Dynamics CRM server.

Syntax

[Visual Basic .NET]
Public Sub Sync(
  ByVal syncType As OutlookSyncType
)
[C#]
public void Sync(
  OutlookSyncType  syncType
);

Parameters

syncType

The target to which synchronization needs to be triggered: Outlook, the Microsoft Dynamics CRM Address Book Provider or the Offline database. This parameter is an OutlookSyncType enumeration type.

Return Value

No return value.

Remarks

Triggers a synchronization event between Microsoft Dynamics CRM for Outlook and the Microsoft Dynamics CRM server. The synchronization occurs in the background and there is no user interaction. If there is a failure during synchronization there is no feedback provided. The method is synchronous and will not return until the synchronization operation is completed.

Synchronization to the offline database cannot be triggered if the client is offline or Microsoft Dynamics CRM for Outlook is installed.

Throws an InvalidOperationException if the client is not loaded, Microsoft Dynamics CRM for Outlook is installed, or if the client is offline.

Throws an ArgumentException if the syncType is not supported.

Requirements

Namespace: Microsoft.Crm.Outlook.Sdk

Assembly: Microsoft.Crm.Outlook.Sdk.dll

See Also

Tasks

Reference


© 2010 Microsoft Corporation. All rights reserved.


Show: