IOfflineFilesErrorInfo::GetDescription method

Retrieves a text string describing the error. In most cases, this is the system error string reported for the sync result using the Win32 function FormatMessage.

Syntax

HRESULT GetDescription(
  LPWSTR *ppszDescription
);

Parameters

ppszDescription

Receives the address of a text string describing the error. The caller must free this memory block by using the CoTaskMemFree function.

Return Value

Returns S_OK if successful, or an error value otherwise.

Requirements

   
Windows version Windows Vista Windows Server 2008
Target Platform Windows
Header cscobj.h
DLL CscSvc.dll; CscObj.dll

See Also

FormatMessage

IOfflineFilesErrorInfo