IXpsOMVisualBrush::SetVisualLookup method
Sets the lookup key name of the shared visual, which is stored in a resource dictionary, to be used as the source for the brush.
Syntax
HRESULT SetVisualLookup(
[in] LPCWSTR lookup
);
Parameters
- lookup [in]
The lookup key name of the shared visual to be used as the source for the brush. If a lookup key has already been set, a NULL pointer will clear it.
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_INVALID_RESOURCE_KEY | According to the XML Paper Specification, the value of lookup is not a valid lookup key string. |
| XPS_E_INVALID_LOOKUP_TYPE | The lookup key name in key references an object that is not a geometry. |
| XPS_E_LOOKUP_NOT_FOUND | No object could be found with a key name that matched the value passed in key. |
Remarks
After you call SetVisualLookup, the local visual is released and GetVisualLocal returns a NULL pointer in the visual parameter. The table that follows explains the relationship between the local and lookup values of this property.
| Most recent method called | Object that is returned in visual by GetVisual | Object that is returned in visual by GetVisualLocal | String that is returned in lookup by GetVisualLookup |
|---|---|---|---|
The visual that is set by SetVisualLocal. |
The visual that is set by SetVisualLocal. |
NULL pointer. |
|
SetVisualLookup (this method). |
The visual that is retrieved, with a lookup key that matches the key set by SetVisualLookup, from the resource directory. |
NULL pointer. |
The lookup key that is set by SetVisualLookup. |
Neither SetVisualLocal nor SetVisualLookup 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 |