IXpsOMImageBrush::SetImageResource method (xpsobjectmodel.h)

Article
02/22/2024

Sets a pointer to the IXpsOMImageResource interface that contains the image resource to be used as the source for the brush.

Syntax

HRESULT SetImageResource(
  [in] IXpsOMImageResource *imageResource
);

Parameters

[in] imageResource

The image resource to be used as the source for the brush. This parameter must not be a 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	imageResource is NULL.
XPS_E_NO_CUSTOM_OBJECTS	imageResource does not point to a recognized interface implementation. Custom implementation of XPS Document API interfaces is not supported.

Remarks

The image resource must be of type JPEG, PNG, TIFF 6.0, or HD Photo.

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