IXpsOMImageBrush::SetImageResource method

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

  • imageResource [in]
    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

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

IXpsOMImageBrush

XPS_IMAGE_TYPE

IXpsOMImageResource

XPS Document Errors

XML Paper Specification