IXpsOMGradientBrush::GetTransformLookup method (xpsobjectmodel.h)

Article
02/22/2024

Gets the name of the lookup key of the shared matrix transform interface that is to be used for the brush.

The key name identifies a shared resource in a resource dictionary.

Syntax

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

Parameters

[out, retval] key

The name of the lookup key of the shared matrix transform interface that is to be used for the brush. If the lookup key name has not been set or if the local matrix transform has been set, a NULL pointer is returned.

The value that is returned in this parameter depends on which method has been most recently called to set the lookup key or the transform.

Most recent method called	String that is returned in key
SetTransformLocal	NULL pointer.
SetTransformLookup	The key that is set by SetTransformLookup.
Neither SetTransformLocal nor SetTransformLookup 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 does not return an IXpsOMMatrixTransform interface pointer; to retrieve this pointer from the dictionary, call IXpsOMDictionary::GetByKey.

The transform determines how the gradient is transformed. The visible part of the gradient that is ultimately rendered in the image is determined by the path, stroke, or glyph that is using the gradient brush.

This method allocates the memory used by the string that is 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