Ovis_Segmented_Line_Segment_Pattern_Get()
摘要
返回分段线中某个线段的图案(pattern)。
语法
Ovis_Segmented_Line_Segment_Pattern_Get (seg_line_ptr, index, pattern_ptr)
| 参数 | 类型 | 说明 |
|---|---|---|
seg_line_ptr |
OvisT_Segmented_Line * |
分段线 |
index |
unsigned char |
线段的索引编号 |
pattern_ptr |
unsigned int * |
线段的图案 |
返回类型
OvisT_Compcode
若装饰对象是有效的二维或三维分段线,返回 OvisC_Compcode_Success;否则返回 OvisC_Compcode_Failure。
头文件
ovis_decoration.h
详情
该函数返回分段线中某个线段的图案。
示例
OvisT_2D_Segmented_Line * line;
unsigned int pattern;
/* … .line created at some point */
Ovis_Segmented_Line_Segment_Pattern_Get (line, 0, &pattern);
错误
- 装饰对象不是分段线(segmented Line)。
- 装饰对象为 NIL。
- 从 0 开始的线段索引(
<index>)对于<num>个线段来说过大。 - 不能使用 'OVISC_SEGMENTED_LINE_ALL_SEGMENTS' 索引值。
- 图案值的返回地址为 NIL。
参考
- 使用函数
Ovis_Segmented_Line_Segment_Pattern_Set()指定线段的图案。