prg_preference_value_set()
摘要
设置偏好的值,并确保该属性在用户选择 Edit Preferences 时出现。
语法
prg_preference_value_set (attr_type, group_name, attr_name, description_string, options, value_ptr)
| 参数 | 类型 | 说明 |
|---|---|---|
attr_type |
PrgT_Env_Attr_Type |
偏好的数据类型。 [该值必须是已定义的偏好类型,否则会发生错误。可用类型列于符号常量。 |
group_name |
const char* |
要设置的属性的组名:Standard、FLS、GUI 等。 |
attr_name |
const char* |
要设置的属性的名称。 |
description_string |
const char* |
属性的描述。此参数可以为空字符串(“”)。 |
options |
int |
用于指定二进制选项的标志。此参数保留供将来使用。目前唯一定义的值是 PRGC_PREFERENCE_OPT_NONE。 |
value_ptr |
void* |
指向要赋给 attr_name 的值的指针。该值的类型必须与 attr_type 指定的类型一致,并且应将指针转换为引用正确的数据类型。 |
返回类型
PrgT_Compcode
指示操作是否成功完成的完成代码。该代码可与两个符号常量 PrgC_Compcode_Success 和 PrgC_Compcode_Failure 进行比较。
头文件
prg_env.h
示例
sprintf (attr_name, "engs_dir");
if ((status = prg_preference_value_set (PrgC_Env_Attr_String,
ENGSC_ATTR_GROUP, attr_name,
ENGSC_ATTR_DIR_DESC, PRGC_PREFERENCE_OPT_NONE, attr_value)) ==
PrgC_Compcode_Failure)
{
/* Could not set the engs_dir environment variable. */
printf("\nCould not set %s preference\n\n", attr_name);
}
详情
此函数允许设置和/或修改偏好。
此过程允许你
- 修改现有的系统属性(例如 mod_dirs、opnet_dir、num_errors 等)。
- 添加新属性。如果创建的属性不存在,则会产生一个新属性。
- 设置在偏好文件(.prefs)中定义的自有属性。
若属性类型为 PrgT_List,在调用此函数之前,必须使用 prg_list_create() 或 prg_list_init() 之类的函数为 value_ptr 分配并初始化列表。
目的
提供一种从当前进程创建和设置偏好的机制。
此函数与 prg_env_attr_value_set() 的区别在于:prg_preference_value_set() 确保它所设置(并创建)的任何属性随后都会在用户选择 Edit Preferences 时出现;而 prg_env_attr_value_set() 不保证这一行为。
错误
- 程序中止:段错误,由于无效的值指针、指向内存不足的指针,或
group_name、attr_name、description_string、value_ptr的地址无效)
参考
- 使用 prg_env_attr_value_get() 获取偏好的值
- 使用 prg_env_attr_value_set() 更改偏好的值
- 使用 prg_preference_value_get() 获取偏好的值(并确保其出现在 Edit Preferences 对话框中)