IXpsOMCoreProperties::GetDescription method

Gets the description property.

Syntax

HRESULT GetDescription(
  LPWSTR *description
);

Parameters

description

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 | UWP apps]
Minimum supported server Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header xpsobjectmodel.h

See Also

IXpsOMCoreProperties

Standard ECMA-376, Office Open XML File Formats

XML Paper Specification

XPS Document Errors