IXpsOMVisual::GetOpacityMaskBrushLookup method (xpsobjectmodel.h)

Article
02/22/2024

Gets the name of the lookup key of the shared opacity mask brush in a resource dictionary.

Syntax

HRESULT GetOpacityMaskBrushLookup(
  [out, retval] LPWSTR *key
);

Parameters

[out, retval] key

The name of the lookup key of the shared opacity mask brush in a resource dictionary. If the lookup key of an opacity mask brush has not been set, or if a local opacity mask brush has been set, a NULL pointer is returned.

Most recent method called	Object that is returned in key
SetOpacityMaskBrushLocal	NULL pointer.
SetOpacityMaskBrushLookup	The lookup key that is set by SetOpacityMaskBrushLookup.
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	key is NULL.

Remarks

This method allocates the memory that is used by the string returned in key. If key is not NULL, use the CoTaskMemFree function to free the memory.

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