CRMRichClientSync.EndSync Method
The EndSync method ends an offline synchronization operation.
Syntax
[Visual Basic .NET]
Public Sub EndSync(
ByVal Caller As CUserAuth,
ByVal SubscriptionId As String
)
[C#]
public void EndSync(
CUserAuth Caller,
string SubscriptionId
);
[C++]
public: void EndSync(
CUserAuth* Caller,
String* SubscriptionId
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadOrganization, prvReadBusinessUnit, prvReadUser, prvReadUserSettings, prvReadTeam, prvReadRole, and prvReadLicense privileges. See CUserAuth.
SubscriptionId
Specifies the ID of the subscription.
Return Value
No return value.
Remarks
If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.
All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}
Example
[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";
// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServer + "/" + virtualDirectory + "/";
// BizUser proxy object
Microsoft.Crm.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMRichClientSync proxy object
Microsoft.Crm.Platform.Proxy.CRMRichClientSync richclientsync = new Microsoft.Crm.Platform.Proxy.CRMRichClientSync();
richclientsync.Credentials = System.Net.CredentialCache.DefaultCredentials;
richclientsync.Url = strDir + "CRMRichclientsync..srf";
string strErrorMsg;
string strSubscriptionId = "{57ELDC97-KL8E-3371-9022-7DKCFBD0F0E3}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// End the synchronization
richclientsync.EndSync(userAuth, strSubscriptionId);
}
catch (System.Web.Services.Protocols.SoapException err)
{
// Process the platform error here
strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
// Process other errors here
strErrorMsg = ("ErrorMessage: " + err.Message );
}
Requirements
Namespace: Microsoft.Crm.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also