IXpsOMVisual::GetOpacityMaskBrushLookup method

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

• key [out, retval]
  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.

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

See also

IXpsOMVisual

IXpsOMBrush

XPS Document Errors

XML Paper Specification