Share via


IXpsOMGlyphs::GetFillBrush method

Gets a pointer to the resolved IXpsOMBrush interface of the fill brush to be used for the text.

Syntax

HRESULT GetFillBrush(
  [out, retval] IXpsOMBrush **fillBrush
);

Parameters

  • fillBrush [out, retval]
    A pointer to the resolved IXpsOMBrush interface of the fill brush to be used for the text. If a fill brush has not been set, a NULL pointer will be 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 fillBrush

    SetFillBrushLocal

    The local brush that is set by SetFillBrushLocal.

    SetFillBrushLookup

    The shared brush retrieved, with a lookup key that matches the key that is set by SetFillBrushLookup, from the local or resource directory.

    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

fillBrush is NULL.

XPS_E_LOOKUP_INVALID_TYPE

The lookup key name set by SetStrokeBrushLookup 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 lookup value.

 

Remarks

The fill brush is used to fill the shape of the rendered glyphs.

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

See also

IXpsOMGlyphs

IXpsOMBrush

XPS Document Errors

XML Paper Specification