prg_preference_value_get()
摘要
获取偏好的值,并确保该属性在用户选择 Edit Preferences 时出现。
语法
prg_preference_value_get (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* |
指向某个变量的指针,该变量将被填入指定属性的值。更多信息见详情一节。 |
返回类型
PrgT_Compcode
指示操作是否成功完成的完成代码。该代码可与两个符号常量 PrgC_Compcode_Success 和 PrgC_Compcode_Failure 进行比较。
头文件
prg_env.h
示例
sprintf (attr_name, "engs_dir");
if ((status = prg_preference_value_get (PrgC_Env_Attr_String,
ENGSC_ATTR_GROUP, attr_name,
ENGSC_ATTR_DIR_DESC, PRGC_PREFERENCE_OPT_NONE, attr_value)) ==
PrgC_Compcode_Failure)
{
/* Unable to obtain the engs_dir environment variable. */
printf("\nUnable to obtain %s preference\n\n", attr_name);
}
详情
value_ptr 参数可以接受一个字符串,或指向 integer、double 或 PrgT_List 类型变量的指针。参数指针的数据类型必须与指定属性的数据类型一致,否则会发生错误。
- 对于字符串,字符数组必须足够大,能够容纳该属性的值。
- 若属性类型为
PrgT_Boolean,返回值将是PRGC_TRUE或PRGC_FALSE。 - 若属性类型为
PrgT_List,在调用此函数之前,必须使用 prg_list_create() 或 prg_list_init() 之类的函数为value_ptr分配并初始化列表。
目的
提供一种从当前进程获取偏好的机制。可以获取当前进程中某个偏好的值。
此函数与 prg_env_attr_value_get() 的区别在于:prg_preference_value_get() 确保它所请求的任何属性随后都会在用户选择 Edit Preferences 时出现;而 prg_env_attr_value_get() 不保证这一行为。
错误
- 程序中止:段错误(由于无效的值指针、指向内存不足的指针,或
group_name、attr_name、description_string、value_ptr的地址无效)
参考
- 使用 prg_env_attr_value_get() 获取偏好的值
- 使用 prg_env_attr_value_set() 更改偏好的值
- 使用 prg_preference_value_set() 设置偏好的值(并确保其出现在 Edit Preferences 对话框中)