IGR_Canvas_TextOut¶
Writes a string on the canvas, starting at X and Y, and then updates the pen position to the end of the string. The text is written with the current font, and filled with the current brush.
Prototype¶
IGR_LONG IGR_Canvas_TextOut(
HCANVAS canvas,
IGR_LONG x,
IGR_LONG y,
const IGR_UCS2* text,
Error_Control_Block* error);
Parameters¶
Canvas: HCANVAS
Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.
X: IGR_LONG
Left-most coordinate of the bounding box.
Y: IGR_LONG
Top-most coordinate of the bounding box.
Text: Unicode string (UCS2)
The text to output to the canvas. The string must be NULL terminated.
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.