Partager via


IXpsOMCoreProperties::SetDescription method

Sets the description property.

Syntax

HRESULT SetDescription(
  [in] LPCWSTR description
);

Parameters

  • description [in]
    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 | 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

See also

IXpsOMCoreProperties

XML Paper Specification

Standard ECMA-376, Office Open XML File Formats