IXpsOMDocument::SetDocumentStructureResource method

Sets the IXpsOMDocumentStructureResource interface for the document.

Syntax


HRESULT SetDocumentStructureResource(
  [in] IXpsOMDocumentStructureResource *documentStructureResource
);

Parameters

documentStructureResource [in]

A pointer to the IXpsOMDocumentStructureResource interface to be assigned to the document. A NULL pointer releases any previously assigned resource.

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 codeDescription
S_OK

The method succeeded.

XPS_E_NO_CUSTOM_OBJECTS

documentStructureResource does not point to a recognized interface implementation. Custom implementation of XPS Document API interfaces is not supported.

 

Remarks

If the document contains an IXpsOMDocumentStructureResource interface when this method is called, that interface is released before the new IXpsOMDocumentStructureResource interface, which is passed in documentStructureResource, is set.

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

IXpsOMDocument
IXpsOMDocumentStructureResource
XPS Document Errors
XML Paper Specification

 

 

Show: