IXpsOMCanvas::SetDictionaryLocal method (xpsobjectmodel.h)

Article
10/13/2021

Sets the IXpsOMDictionary interface pointer of the local, unshared dictionary.

Syntax

HRESULT SetDictionaryLocal(
  [in] IXpsOMDictionary *resourceDictionary
);

Parameters

[in] resourceDictionary

The IXpsOMDictionary interface of the local, unshared dictionary. A NULL pointer releases any previously assigned local dictionary.

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.
XPS_E_NO_CUSTOM_OBJECTS	resourceDictionary does not point to a recognized interface implementation. Custom implementation of XPS Document API interfaces is not supported.

Remarks

After you call SetDictionaryLocal, the remote dictionary resource is released and GetDictionaryResource returns a NULL pointer in the remoteDictionaryResource parameter. The table that follows explains the relationship between the local and remote values of this property.

Most recent method called	Object that is returned in resourceDictionary by GetDictionary	Object that is returned in resourceDictionary by GetDictionaryLocal	Object that is returned in remoteDictionaryResource by GetDictionaryResource
SetDictionaryLocal (this method)	The local dictionary that is set by SetDictionaryLocal.	The local dictionary that is set by SetDictionaryLocal.	NULL pointer.
SetDictionaryResource	The shared dictionary in the dictionary resource that is set by SetDictionaryResource.	NULL pointer.	The remote dictionary resource that is set by SetDictionaryResource.
Neither SetDictionaryLocal nor SetDictionaryResource has been called yet.	NULL pointer.	NULL pointer.	NULL pointer.

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