IXpsOMCoreProperties::GetDescription method
Gets the description property.
Syntax
HRESULT GetDescription(
[out, retval] LPWSTR *description
);
Parameters
- description [out, retval]
The string that is read from the description property.
Return value
The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For information about XPS document API return values that are not listed in this table, see XPS Document Errors.
| Return code | Description |
|---|---|
| S_OK | The method succeeded. |
| E_POINTER | description is NULL. |
Remarks
The description property provides an explanation of the content.
This method allocates the memory used by the string that is returned in description. If description is not NULL, use the CoTaskMemFree function to free the memory.
Requirements
Minimum supported client |
Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | Windows Store apps] |
Minimum supported server |
Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | Windows Store apps] |
Header |
Xpsobjectmodel.h |
IDL |
XpsObjectModel.idl |