IXpsOMGlyphs::SetFillBrushLookup method (xpsobjectmodel.h)

Article
10/13/2021

Sets the lookup key name of a shared fill brush.

Syntax

HRESULT SetFillBrushLookup(
  [in] LPCWSTR key
);

Parameters

[in] key

A string variable that contains the key name of the fill brush that is stored in the resource dictionary and will be used as the shared fill brush. A NULL pointer clears any previously assigned key string.

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 SetFillBrushLookup, the local fill brush is released and GetFillBrushLocal returns a NULL pointer in the fillBrush 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 fillBrush by GetFillBrush	Object that is returned in fillBrush by GetFillBrushLocal	String that is returned in key by GetFillBrushLookup
SetFillBrushLocal	The local brush that is set by SetFillBrushLocal.	The local brush that is set by SetFillBrushLocal.	NULL pointer.
SetFillBrushLookup (this method)	The shared brush that gets retrieved, with a lookup key matching 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

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