IXpsOMCanvas::GetDictionaryLocal method (xpsobjectmodel.h)

Article
02/22/2024

Gets a pointer to the IXpsOMDictionary interface of the local, unshared dictionary.

Syntax

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

Parameters

[out, retval] resourceDictionary

The IXpsOMDictionary interface pointer to the local, unshared dictionary, if one has been set. If a local dictionary has not been set or if a remote dictionary resource has been set, a NULL pointer is returned.

Most recent method called	Object returned in resourceDictionary
SetDictionaryLocal	The local dictionary that is set by SetDictionaryLocal.
SetDictionaryResource	NULL pointer.
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.

Remarks

When this method loads and parses the resource into the XPS OM, it might return an error that applies to another resource. This can occur because all of the relationships are parsed when the resource is loaded.

For more information about other return values that might be returned by this method, see XPS Document Errors.

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