IXpsOMPage::GetDictionary method (xpsobjectmodel.h)

Article
02/22/2024

Gets a pointer to the resolved IXpsOMDictionary interface that is associated with this page.

Syntax

HRESULT GetDictionary(
  [out, retval] IXpsOMDictionary **resourceDictionary
);

Parameters

[out, retval] resourceDictionary

A pointer to the resolved IXpsOMDictionary interface that is associated with this page.

The value that is returned in this parameter depends on which method has most recently been called to set the dictionary.

Most recent method called	Object that is returned in resourceDictionary
SetDictionaryLocal	The local dictionary resource that is set by SetDictionaryLocal.
SetDictionaryResource	The shared dictionary in the 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	resourceDictionary is NULL.
XPS_E_LOOKUP_INVALID_TYPE	The lookup key name set by SetStrokeBrushLookup references an object that is not a brush.
XPS_E_LOOKUP_NOT_FOUND	No object could be found with a key name that matched the lookup value. No object could be found with a key name that matched the value passed in lookup.

Remarks

Whether the dictionary is local or is contained within a remote dictionary resource, this method returns an IXpsOMDictionary interface pointer. GetOwner determines whether the dictionary is remote.

If a page contains a remote dictionary, GetDictionary will deserialize the dictionary. If the page contains a remote dictionary that is not valid, GetDictionary might return a deserialization error code.

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