IXpsOMTileBrush::SetTransformLocal method

Sets the IXpsOMMatrixTransform interface pointer to a local, unshared matrix transform.

Syntax

HRESULT SetTransformLocal(
  [in] IXpsOMMatrixTransform *transform
);

Parameters

  • transform [in]
    A pointer to the IXpsOMMatrixTransform interface to be set as the local, unshared matrix transform. If a local transform has been set, a NULL pointer will release it.

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

transform does not point to a recognized interface implementation. Custom implementation of XPS Document API interfaces is not supported.

 

Remarks

The transform determines how the output area is transformed before the brush image is rendered in the path, stroke, or glyph that is using the tile brush.

After you call SetTransformLocal, the transform lookup key is released and GetTransformLookup 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 transform by GetTransform Object that is returned in transform by GetTransformLocal String that is returned in key by GetTransformLookup

SetTransformLocal (this method)

The transform that is set by SetTransformLocal.

The transform that is set by SetTransformLocal.

NULL pointer.

SetTransformLookup

The transform which is retrieved, using a lookup key that matches the key that is set by SetTransformLookup, from the resource directory.

NULL pointer.

The lookup key that is set by SetTransformLookup.

Neither SetTransformLocal nor SetTransformLookup 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

See also

IXpsOMTileBrush

IXpsOMMatrixTransform

XPS Document Errors

XML Paper Specification