Ovis_Segmented_Line_Num_Segments_Get()
Abstract
Returns the number of segments in a segmented line.
Syntax
Ovis_Segmented_Line_Num_Segments_Get (seg_line_ptr, num_ptr)
| Argument | Type | Description |
|---|---|---|
seg_line_ptr |
OvisT_Segmented_Line * |
Segmented line |
num_ptr |
unsigned char * |
Number of line segments |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the decoration is a valid 2D or 3D segmented line; OvisC_Compcode_Failure otherwise.
Header
ovis_decoration.h
Details
This function returns the number of segments in the segmented line.
Example
OvisT_2D_Segmented_Line * line;
unsigned char count;
/* … .line created at some point */
Ovis_Segmented_Line_Num_Segments_Get (line, &count);
Errors
- Decoration is not a segmented Line.
- Decoration is NIL.
- Return address for segment count is NIL.
Reference
- Use the function
Ovis_Segmented_Line_Num_Segments_Set()to specify the number of segments in a line.