IXpsOMPath::SetStrokeBrushLocal method
Sets a pointer to a local, unshared IXpsOMBrush interface to be used as a stroke brush.
Syntax
HRESULT SetStrokeBrushLocal(
[in] IXpsOMBrush *brush
);
Parameters
- brush [in]
A pointer to a local, unshared IXpsOMBrush interface to be used as a stroke 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 | brush does not point to a recognized interface implementation. Custom implementation of XPS Document API interfaces is not supported. |
Remarks
After you call SetStrokeBrushLocal, the stroke brush lookup key is released and GetStrokeBrushLookup returns a NULL pointer in the lookup 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 brush by GetStrokeBrush | Object that is returned in brush by GetStrokeBrushLocal | String that is returned in lookup by GetStrokeBrushLookup |
|---|---|---|---|
SetStrokeBrushLocal (this method) |
The local brush that is set by SetStrokeBrushLocal. |
The local brush that is set by SetStrokeBrushLocal. |
NULL pointer. |
The shared brush retrieved, with a lookup key that matches the key set by SetStrokeBrushLookup, from the resource directory. |
NULL pointer. |
The lookup key that is set by SetStrokeBrushLookup. |
|
Neither SetStrokeBrushLocal nor SetStrokeBrushLookup 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 |