IXpsOMBrush::GetOpacity method (xpsobjectmodel.h)

Gets the opacity of the brush.

Syntax

HRESULT GetOpacity(
  [out, retval] FLOAT *opacity
);

Parameters

[out, retval] opacity

The opacity value of the brush.

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
opacity is NULL.

Remarks

opacity is expressed as a value between 0.0 and 1.0; 0.0 indicates that the brush is completely transparent, 0.5 that it is 50 percent opaque, and 1.0 that it is completely opaque.

Requirements

   
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

XML Paper Specification

XPS Document Errors