Ovis_2D_Text_Position_Get()
Abstract
Returns the 2D position of the text.
Syntax
Ovis_2D_Text_Position_Get (text_ptr, position_ptr)
| Argument | Type | Description |
|---|---|---|
text_ptr |
OvisT_2D_Text * |
Text |
position_ptr |
OvisT_2D_Position * |
Position the text |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the provided object is a valid 2D text pointer. Otherwise, it returns OvisC_Compcode_Failure.
Header
ovis_decoration.h
Details
This function returns the coordinates of the 2D text.
Example
OvisT_2D_Position pos;
OvisT_2D_Text * text;
/* … text created at some point with an initial position */
Ovis_2D_Text_Position_Get (text, &pos);
Errors
- Return address for position value is NIL.
- Decoration is NIL.
- Decoration is not a 2D text.
Reference
- Use the function
Ovis_2D_Text_Position_Set()to specify the position of the text.