IXpsOMCanvas::GetDictionary method (xpsobjectmodel.h)
Gets a pointer to the resolved IXpsOMDictionary interface of the dictionary associated with the canvas.
Syntax
HRESULT GetDictionary(
[out, retval] IXpsOMDictionary **resourceDictionary
);
Parameters
[out, retval] resourceDictionary
A pointer to the resolved IXpsOMDictionary interface of the dictionary.
The value that is returned in this parameter depends on which method has been most recently called to set the dictionary.
| Most recent method called | Object returned in resourceDictionary |
|---|---|
| The local dictionary that is set by SetDictionaryLocal. | |
| 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 |
|---|---|
|
The method succeeded. |
|
resourceDictionary is NULL. |
Remarks
GetDictionary can return the interface pointer of a local or remote dictionary. GetOwner can be called to determine whether the dictionary is local or remote.
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 |