IGR_Canvas_TextRect¶

Writes a string inside a clipping rectangle, using the current brush and font.

Prototype¶

C/C++

IGR_LONG IGR_Canvas_TextRect(
    HCANVAS canvas,
    IGR_LONG x,
    IGR_LONG y,
    IGR_LONG x2,
    IGR_LONG y2,
    const IGR_UCS2* text,
    IGR_LONG flags,
    Error_Control_Block* error);

Parameters¶

Canvas: HCANVAS

Handle to a canvas.

X: IGR_LONG

Left-most coordinate of the bounding box.

Y: IGR_LONG

Top-most coordinate of the bounding box.

X2: IGR_LONG

Right-most coordinate of the bounding box.

Y2: IGR_LONG

Bottom-most coordinate of the bounding box.

Text: Pointer to Unicode String

The text to output to the canvas.The string must be NULL terminated.

Flags: IGR_LONG

Reserved for future use.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

Return value¶

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

Additional information¶

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not supported.