ISyncMgrSyncCallback::SetHandlerProgressText method

Sets the content of an information field for the handler while that handler is performing a synchronization.

Syntax


HRESULT SetHandlerProgressText(
  [in]      LPCWSTR                pszProgressText,
  [in, out] SYNCMGR_CANCEL_REQUEST *pnCancelRequest
);

Parameters

pszProgressText [in]

Type: LPCWSTR

Pointer to a buffer containing the comment text.

pnCancelRequest [in, out]

Type: SYNCMGR_CANCEL_REQUEST*

A value from the SYNCMGR_CANCEL_REQUEST enumeration specifying the nature of a cancel request, if any.

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 ISyncMgrSyncCallback::SetHandlerProgressText by the Synchronize method.


STDMETHODIMP CMyDeviceHandler::Synchronize(...)
{
    ...

    // Start synchronizing the sync item.

    ...

    // Construct a string to display in the Sync Center folder.
    // Set the progress text on the handler.
    hr = pCallback->SetHandlerProgressText(pszHandlerProgressText);
    ...
}


Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Syncmgr.h

IDL

Syncmgr.idl

 

 

Show: