IOfflineFilesErrorInfo::GetDescription method (cscobj.h)

  • Article

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(
  [out] LPWSTR *ppszDescription
);

Parameters

[out] 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

Requirement Value
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Target Platform Windows
Header cscobj.h
DLL CscSvc.dll; CscObj.dll

See also

FormatMessage

IOfflineFilesErrorInfo