Edit

Share via

ISyncMgrHandler::GetName method (syncmgr.h)

  • Article

Gets the display name of the handler.

Syntax

HRESULT GetName(
  [out] LPWSTR *ppszName
);

Parameters

[out] ppszName

Type: LPWSTR*

When this method returns, contains a pointer to a null-terminated buffer that receives the handler name. The name can be of maximum length MAX_SYNCMGR_NAME, including the terminating null character. If the name exceeds that length, it is truncated.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The handler name is accessed as the System.DisplayName (PKEY_DisplayName) property in the Sync Center folder.

Sync Center calls this method any time that UpdateHandler or UpdateHandlerCollection is called. If ISyncMgrHandler::GetName fails or returns an empty string, the handler is not shown in the Sync Center folder and Sync Center will not attempt to invoke it.

It is the responsibility of the handler to allocate the string buffer using CoTaskMemAlloc. Sync Center deallocates the buffer through CoTaskMemFree.

ISyncMgrHandler::GetName replaces the use of GetHandlerInfo to retrieve the handler name.

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