Edit

Share via

IXpsOMVisual::GetOpacityMaskBrush method (xpsobjectmodel.h)

  • Article

Gets a pointer to the IXpsOMBrush interface of the visual's opacity mask brush.

Syntax

HRESULT GetOpacityMaskBrush(
  [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 has not been set for this visual, 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 opacityMaskBrush

SetOpacityMaskBrushLocal

 The local opacity mask brush that is set by SetOpacityMaskBrushLocal.

SetOpacityMaskBrushLookup

 The shared opacity mask brush that gets retrieved, with a lookup key that matches the key that is set by SetOpacityMaskBrushLookup, from the resource directory.
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.
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.

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