IXpsOMPath::GetStrokeBrushLookup method (xpsobjectmodel.h)

Gets the lookup key of the brush that is stored in a resource dictionary and is to be used as the stroke brush for the path.

Syntax

HRESULT GetStrokeBrushLookup(
  [out, retval] LPWSTR *lookup
);

Parameters

[out, retval] lookup

The lookup key of a brush that is stored in a resource dictionary. If a stroke brush lookup key has not been set or if a local stroke brush has been set, a NULL pointer is returned.

Most recent method called String that is returned in lookup

SetStrokeBrushLocal

NULL pointer.

SetStrokeBrushLookup

The lookup key that is set by SetStrokeBrushLookup.
Neither SetStrokeBrushLocal nor SetStrokeBrushLookup 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
lookup is NULL.

Remarks

This method allocates the memory used by the string that is returned in lookup. If lookup 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

See also

IXpsOMPath

XML Paper Specification

XPS Document Errors