Ovis_Text_String_Get()
Abstract
Returns the Ovis decoration text string.
Syntax
Ovis_Text_String_Get (text_ptr, buf_size, buffer)
| Argument | Type | Description |
|---|---|---|
text_ptr |
OvisT_Text * |
Ovis text string |
buf_size_ptr |
size_t * |
Maximum length of the buffer, in bytes |
buffer |
char * |
Buffer |
Return Type
OvisT_Compcode
If the buffer size is not big enough to store the text value, buf_size_ptr is set to the needed size and the function returns OvisC_Compcode_Failure.
Header
ovis_decoration.h
Details
This function returns the text string of the Ovis decoration.
Example
OvisT_2D_Text * text;
size_t size;
char buffer [100];
/* … text created at some point */
size = 100;
Ovis_Text_String_Get (text, &size, buffer);
Errors
- Decoration is NIL.
- Size argument is NIL.
- String buffer is NIL.
- Text may only be retrieved from text objects.
Reference
- Use the function Ovis_Text_String_Set() to specify the text value.