Edit

Share via

ISyncMgrEvent::GetName method (syncmgr.h)

  • Article

Gets the name of the event. This string can be a simple name for the event or a short summary. It is displayed in the folder and in the property sheet for the event.

Syntax

HRESULT GetName(
  [out] LPWSTR *ppszName
);

Parameters

[out] ppszName

Type: LPWSTR*

When this method returns, contains a pointer to a name as a Unicode string.

Return value

Type: HRESULT

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

Remarks

The event is expected to allocate the string buffer using CoTaskMemAlloc, which Sync Center uses to deallocate the string buffer.

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