IXpsOMPath::GetFillBrushLocal method (xpsobjectmodel.h)

Gets a pointer to the local, unshared IXpsOMBrush interface that contains the fill brush for the path.

Syntax

HRESULT GetFillBrushLocal(
  [out, retval] IXpsOMBrush **brush
);

Parameters

[out, retval] brush

A pointer to the IXpsOMBrush interface to be used as the local, unshared fill brush for the path. If a fill brush lookup key has been set or if a local fill brush has not been set, a NULL pointer is returned.

The value that is returned in this parameter depends on which method has most recently been called to set the brush.

Most recent method called	Object that is returned in brush
SetFillBrushLocal	The local brush that is set by SetFillBrushLocal.
SetFillBrushLookup	NULL pointer.
Neither SetFillBrushLocal nor SetFillBrushLookup 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
S_OK	The method succeeded.
E_POINTER	brush is NULL.

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

See also

IXpsOMBrush

IXpsOMPath

XML Paper Specification

XPS Document Errors