第 3 章 编程基础
3.1 UG/Open API 函数
3.1.1 函数名称的约定
UG/OpenAPI 共有两类名称约定。一个是标准的 UG/OpenAPI 的函数
名称约定;另一个是以前版本原有的名称约定。
1、标准名称约定
格式: UF__
说明:
UF_,user funciton 的简写,表示该函数为 UG/Open API函数;
,应用或模块的名称缩写。例如 modl 和 disp 分别是
Modeling 模块和 Display 功能的名称缩写;
,表示其实现功能的语言描述,一般由下划线分开的动词
和名词(或词组)组成。常用的动词有: ask (查询)、create
(创建)、edit (编辑)、set (设置)、delete (删除)等。
例如:
UF_MODL_create_block1()为创建立方体的函数;
UF_DISP_set_highlight() 是高亮显示对象的函数;
(2 )非标准名称约定
格式: uc 和 uf
说明:代表 UG/OpenAPI C 程序, 通常是四位数或三位数接一
个字母。
例如: uc1601 是一个提示信息函数。
3.1.2 函数参数的约定
UG/Open API 提供的函数遵守 ANSI/ISO C 的标准,并以下列格式在
头文件中提供函数原型:
( 变量列表 ) ;
返回数据类型通常是 C 数据类型或 UG/OpenAPI 自定义数据类型。参
数的输入输出方式有 3 种:I (Input )、O(Output )或 OF(Output Free ),
说明见表 3-1 。
表 3-1 参数输入方式说明
元 素 描 述
I 表示参数为输入方式,参数在使用前必须赋值
O 表示参数为输出方式,使用前无须赋值
表示参数为输出方式,且使用后需要释放内存。 UG/OpenAPI 提供的常
用 释 放 内 存 函 数 有 UF_free() 、 UF_free_string() 和
OF
UF_STYLER_free_value() 等,至于选择哪种释放函数需视具体情况而
定。
例如:函数 UF_PART_open()
名称: UF_PART_open
使用环境 : internal & external
语法格式 :
int UF_PART_open(
char *part_name,
tag_t *part,
UF_PART_load_status_t *error_status
);
描述:加载一个 UG部件文件到 UG的界面环境中, 并把它设为工作和
当前显示部件,该函数的描述见表 3-2 。
表 3-2 函数 UF_PART_open()参数描述
参数 输入 输出 类型 描述
part_name 输入 char *