IDAImage Interface

The IDAImage interface is the COM interface that defines methods for the DAImage class. You can access all the methods listed in the DAImage class in the Scripting Reference from the IDAImage interface. This section lists only those methods that you can't access from script, but must access through the COM interface, typically using C++. Some of these methods, with an appended "Ex," specify arrays as a size and a fixed array rather than as a VARIANT. Specifying arrays makes the methods easier to call in C++, but not using a VARIANT means you can't call them from script.

This interface inherits from IDABehavior. These are all dispatch interfaces that inherit from IDispatch.

IDAImage Methods

ClipPolygonImageEx Creates a DAImage object by clipping the original image. Allows you to use an array, rather than a VARIANT, to specify the points of the clipping region. This make it easier to call from C++.

IDAImage::ClipPolygonImageEx

IDAImage Class

Creates a DAImage object by clipping the original image. The new image consists of the portion of the original image that is within the closed figure defined by the given DAPoint2 objects. The bounding box is the intersection of the box surrounding the points of the polygon with the box of the underlying image. This method extends IDAImage::ClipPolygonImage by enabling you to specify the array of DAPoint2 objects, rather than using a VARIANT. An array is easier to call from C++ than a VARIANT. However, because it does not use a VARIANT, you can't call this method from script.

Syntax

HRESULT ClipPolygonImageEx(
    LONG pointsSize,
    IDAPoint2 points[],
    IDAImage **ret
);

Parameters

pointsSize

[in] Number of DAPoint2 objects in the array.

points

[size_is(pointsSize), in] Array of DAPoint2 objects representing the endpoints of the line segments that define the figure. If the first and last points are not the same, these points are implicitly connected to close the figure.

ret

[out] Address of a pointer to the clipped DAImage object.

Return Value

Returns an HRESULT value that indicates the success of the method or the reason why it failed. This HRESULT depends on the implementation of the interface.