IXpsOMPage::GetDictionaryResource method

Gets a pointer to the IXpsOMRemoteDictionaryResource interface of the shared dictionary resource that is used by this page.

Syntax


HRESULT GetDictionaryResource(
  [out, retval] IXpsOMRemoteDictionaryResource **remoteDictionaryResource
);

Parameters

remoteDictionaryResource [out, retval]

A pointer to the IXpsOMRemoteDictionaryResource interface of the shared dictionary resource that is used by this page. If no IXpsOMRemoteDictionaryResource interface has been set or if a local dictionary has been set, a NULL pointer is returned.

Most recent method calledObject that is returned in remoteDictionaryResource

SetDictionaryLocal

NULL pointer.

SetDictionaryResource

The remote dictionary resource that is set by SetDictionaryResource.

Neither SetDictionaryLocal nor SetDictionaryResource has been called yet.

NULL pointer.

 

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.

E_POINTER

remoteDictionaryResource is NULL.

 

Remarks

After loading and parsing the resource into the XPS OM, this method might return an error that applies to another resource. This occurs because all of the relationships are parsed when a resource is loaded.

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

IXpsOMPage
IXpsOMRemoteDictionaryResource
XPS Document Errors
XML Paper Specification

 

 

Show: