IXpsOMCoreProperties::GetSubject method

Gets the subject property.

Syntax

HRESULT GetSubject(
  [out, retval] LPWSTR *subject
);

Parameters

  • subject [out, retval]
    The string that is read from the subject 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

subject is NULL.

 

Remarks

The subject property contains the topic of the resource's content.

This method allocates the memory used by the string that is returned in subject. If subject 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

See also

IXpsOMCoreProperties

XPS Document Errors

XML Paper Specification

Standard ECMA-376, Office Open XML File Formats