Ovis_Text_String_Set()
Abstract
Specifies the Ovis decoration text string.
Syntax
Ovis_Text_String_Set (text_ptr, text)
| Argument | Type | Description |
|---|---|---|
text_ptr |
OvisT_Text * |
Specifies the decoration text object |
text |
const char * |
Specifies the text string |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the decoration is a text object. Otherwise, it returns OvisC_Compcode_Failure.
Header
ovis_decoration.h
Details
This function specifies the text string for the decoration text object.
Example
OvisT_2D_Text * text;
/* … text created at some point */
Ovis_Text_String_Set (text, "some string");
Errors
- Decoration is NIL.
- Text may only be set on text objects.
Reference
- Use the function Ovis_Text_String_Get() to retrieve the text value.