ISyncMgrControl::StopHandlerSync method
Stops the synchronization of a specified handler.
Syntax
HRESULT StopHandlerSync(
[in] LPCWSTR pszHandlerID
);
Parameters
- pszHandlerID [in]
-
Type: LPCWSTR
A pointer to a buffer containing the unique ID of the handler. This string is of maximum length MAX_SYNCMGR_ID including the terminating null character.
Return value
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Examples
The following example shows the usage of ISyncMgrControl::StopHandlerSync by a handler's procedure.
void CMyDeviceHandler::MiscProc(...) { ... // Get the Sync Center control object. ISyncMgrControl *pControl = NULL; hr = CoCreateInstance(CLSID_SyncMgrControl, CLSCTX_SERVER, IID_PPV_ARGS(&pControl)); if (SUCCEEDED(hr)) { // Stop synchronizing all sync items for the sync handler. hr = pControl->StopHandlerSync(s_szMySyncHandlerID); pControl->Release(); } ... }
Requirements
|
Minimum supported client |
Windows Vista [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2008 [desktop apps only] |
|
Header |
|
|
IDL |
|
Show: