IXpsOMPage::GetDictionaryResource method (xpsobjectmodel.h)

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

[out, retval] remoteDictionaryResource

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 called Object 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 code Description
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

Requirement Value
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

IXpsOMPage

IXpsOMRemoteDictionaryResource

XML Paper Specification

XPS Document Errors