IXpsOMCanvas::GetVisuals method

Gets a pointer to an IXpsOMVisualCollection interface that contains a collection of the visual objects in the canvas.

Syntax

HRESULT GetVisuals(
  [out, retval] IXpsOMVisualCollection **visuals
);

Parameters

  • visuals [out, retval]
    The collection of the visual objects in the canvas. If no visual objects are attached to the canvas, an empty collection is returned.

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

visuals is NULL.

 

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

IXpsOMCanvas

IXpsOMVisualCollection

XPS Document Errors

XML Paper Specification