ISyncMgrEvent::GetLinkText method (syncmgr.h)
Gets the text for the hot link for the event. The hot link is a displayed property that the user can click to execute an action. This allows the handler to show an available action that the user can see at a glance in the folder. The link text is the text that is displayed to the user.
Syntax
HRESULT GetLinkText(
[out] LPWSTR *ppszLinkText
);
Parameters
[out] ppszLinkText
Type: LPWSTR*
When this method returns, contains a pointer to the link text 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 |