IXpsOMPath::SetFillBrushLocal method (xpsobjectmodel.h)

Article
02/22/2024

Sets the pointer to the local, unshared IXpsOMBrush interface to be used as the fill brush.

Syntax

HRESULT SetFillBrushLocal(
  [in] IXpsOMBrush *brush
);

Parameters

[in] brush

A pointer to the local, unshared IXpsOMBrush interface 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_NO_CUSTOM_OBJECTS	brush does not point to a recognized interface implementation. Custom implementation of XPS Document API interfaces is not supported.

Remarks

After you call SetFillBrushLocal, the fill brush lookup key is released and GetFillBrushLookup returns a NULL pointer in the lookup 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
SetFillBrushLocal (this method)	The local brush that is set by SetFillBrushLocal.	The local brush that is set by SetFillBrushLocal.	NULL pointer.
SetFillBrushLookup	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

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