IXpsOMCoreProperties::SetDescription method

Sets the description property.

Syntax

HRESULT SetDescription(
  LPCWSTR description
);

Parameters

description

The string to be written to the description property. A NULL pointer clears this property.

Return Value

If the method succeeds, it returns S_OK; otherwise, it returns an HRESULT error code.

Remarks

The description property explains the content.

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