IXpsOMPage::SetDictionaryLocal method
Sets the IXpsOMDictionary interface pointer of the page's local dictionary resource.
Syntax
HRESULT SetDictionaryLocal(
[in] IXpsOMDictionary *resourceDictionary
);
Parameters
- resourceDictionary [in]
The IXpsOMDictionary interface pointer to be set for the page. 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 resource that is set by SetDictionaryLocal. |
The local dictionary resource that is set by SetDictionaryLocal. |
NULL pointer. |
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
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 |