IXpsOMVisualBrush::GetVisual method (xpsobjectmodel.h)

Article
02/22/2024

Gets a pointer to the interface of the resolved visual to be used as the source for the brush.

Syntax

HRESULT GetVisual(
  [out, retval] IXpsOMVisual **visual
);

Parameters

[out, retval] visual

A pointer to the IXpsOMVisual interface of the resolved visual object used as the source for the brush. If a visual 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 visual object.

Most recent method called	Object that is returned in visual
SetVisualLocal	The visual that is set by SetVisualLocal.
SetVisualLookup	The visual that is retrieved, with a lookup key that matches the key that is set by SetVisualLookup, from the resource directory.
Neither SetVisualLocal nor SetVisualLookup 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	visual 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

This method returns an IXpsOMVisual interface pointer. However, the
interface that is returned can be any interface that inherits from IXpsOMVisual, such as IXpsOMCanvas, IXpsOMPath, and IXpsOMGlyphs.

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