IXpsOMPath::SetFillBrushLookup method
Sets the lookup key name of a shared brush in a resource dictionary, to be used as the fill brush.
Syntax
HRESULT SetFillBrushLookup(
[in] LPCWSTR lookup
);
Parameters
- lookup [in]
The key name of the brush in a resource dictionary, to be used as the fill brush.
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 lookup references an object that is not a brush. |
| XPS_E_LOOKUP_NOT_FOUND | No object could be found with a key name that matched the value passed in lookup. |
Remarks
After you call SetFillBrushLookup, the local fill brush is released and GetFillBrushLocal returns a NULL pointer in the brush 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 brush by GetFillBrush | Object that is returned in brush by GetFillBrushLocal | String that is returned in lookup by GetFillBrushLookup |
|---|---|---|---|
The local brush that is set by SetFillBrushLocal. |
The local brush that is set by SetFillBrushLocal. |
NULL pointer. |
|
SetFillBrushLookup (this method) |
The shared brush retrieved, with a lookup key that matches the key that is set by SetFillBrushLookup, from the resource directory. |
NULL pointer. |
The lookup key that is set by SetFillBrushLookup. |
Neither SetFillBrushLocal nor SetFillBrushLookup 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 |