IXpsOMVisual::SetOpacityMaskBrushLocal method
Sets the IXpsOMBrush interface pointer as the local, unshared opacity mask brush.
Syntax
HRESULT SetOpacityMaskBrushLocal(
[in] IXpsOMBrush *opacityMaskBrush
);
Parameters
- opacityMaskBrush [in]
A pointer to the IXpsOMBrush interface to be set as the local, unshared opacity mask brush. A NULL pointer clears the previously assigned opacity mask 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. |
| XPS_E_NO_CUSTOM_OBJECTS | opacityMaskBrush does not point to a recognized interface implementation. Custom implementation of XPS Document API interfaces is not supported. |
Remarks
After you call SetOpacityMaskBrushLocal, the opacity mask brush lookup key is released and GetOpacityMaskBrushLookup returns a NULL pointer in the key parameter. The table that follows explains the relationship between the local and lookup values of this property.
| Most recent method called | Object that is returned in opacityMaskBrush by GetOpacityMaskBrush | Object that is returned in opacityMaskBrush by GetOpacityMaskBrushLocal | String that is returned in key by GetOpacityMaskBrushLookup |
|---|---|---|---|
SetOpacityMaskBrushLocal (this method) |
The local opacity mask brush that is set by SetOpacityMaskBrushLocal. |
The local opacity mask brush that is set by SetOpacityMaskBrushLocal. |
NULL pointer. |
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. |
NULL pointer. |
The lookup key that is set by SetOpacityMaskBrushLookup. |
|
Neither SetOpacityMaskBrushLocal nor SetOpacityMaskBrushLookup has been called yet. |
NULL pointer. |
NULL pointer. |
NULL pointer. |
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 |