IXpsOMGlyphs::GetFillBrushLookup method

Gets the lookup key of the IXpsOMBrush interface that is stored in a resource dictionary and will be used as the fill brush.

Syntax

HRESULT GetFillBrushLookup(
  [out, retval] LPWSTR *key
);

Parameters

  • key [out, retval]
    The lookup key for the brush that is stored in a resource dictionary and will be used as the fill brush. If a fill brush lookup key has not been set or if a local fill brush has been set, a NULL pointer will be returned.

    Most recent method called String that is returned in key

    SetFillBrushLocal

    NULL pointer.

    SetFillBrushLookup

    The lookup key that is set by SetFillBrushLookup.

    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

key is NULL.

 

Remarks

This method allocates the memory that is used by the string returned in key. If key is not NULL, use the CoTaskMemFree function to free the memory.

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

XPS Document Errors

XML Paper Specification