Ovis_Decoration_Flashing_Get()
Abstract
Returns the flashing attribute.
Syntax
Ovis_Decoration_Flashing_Get (dec_ptr, flashing_ptr)
| Argument | Type | Description |
|---|---|---|
dec_ptr |
OvisT_Decoration * |
Ovis decoration |
flashing_ptr |
OvisT_Boolean * |
Specifies the flashing attribute |
Return Type
OvisT_Compcode
Returns OvisC_Compcode_Success if the object is a valid decoration; OvisC_Compcode_Failure otherwise.
Header
ovis_decoration.h
Details
This function indicates whether the decoration is flashing.
Example
OvisT_2D_Line * line;
OvisT_Boolean flash;
/* … line created elsewhere */
Ovis_Decoration_Flashing_Get (line, &flash);
Errors
- Decoration is NIL.
- Return address for flashing value is NIL.
Reference
- Use the function
Ovis_Decoration_Flashing_Set()to specify the flashing status.