ISyncMgrSyncCallback::SetHandlerProgressText method (syncmgr.h)

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

[in] pszProgressText

Type: LPCWSTR

Pointer to a buffer containing the comment text.

[in, out] pnCancelRequest

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.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	syncmgr.h