IXpsOMVisual::GetOpacityMaskBrushLocal method

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

Syntax


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

Parameters

opacityMaskBrush [out, retval]

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 calledObject 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 codeDescription
S_OK

The method succeeded.

E_POINTER

opacityMaskBrush is NULL.

 

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

IXpsOMVisual
IXpsOMBrush
XPS Document Errors
XML Paper Specification

 

 

Show: