IXpsOMVisual::GetOpacityMaskBrushLocal method (xpsobjectmodel.h)

Gets the local, unshared opacity mask brush for the visual.

Syntax

HRESULT GetOpacityMaskBrushLocal(
  [out, retval] IXpsOMBrush **opacityMaskBrush
);

Parameters

[out, retval] opacityMaskBrush

A pointer to the IXpsOMBrush interface of the visual's opacity mask brush. If an opacity mask brush lookup key has been set, or if a local opacity mask brush has not been set, a NULL pointer is returned.

Most recent method called	Object that is returned in opacityMaskBrush
SetOpacityMaskBrushLocal	The local opacity mask brush that is set by SetOpacityMaskBrushLocal.
SetOpacityMaskBrushLookup	NULL pointer.
Neither SetOpacityMaskBrushLocal nor SetOpacityMaskBrushLookup 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	opacityMaskBrush 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

IXpsOMVisual

XML Paper Specification

XPS Document Errors