8.4.2. 参数存取

读取或修改参数的API列表

函数

MDOgetdblparam()	检索double参数的值
MDOgetintparam()	检索整数值参数的值
MDOgetstrparam()	检索字符串值参数的值
MDOsetdblparam()	设置double参数的值
MDOsetintparam()	设置整数值参数的值
MDOsetstrparam()	设置字符串值参数的值
MDOgetdblparaminfo()	检索信息和double参数的当前值
MDOgetintparaminfo()	检索信息和整数值参数的当前值
MDOgetstrparaminfo()	检索字符串值参数的信息和当前值
MDOreadparams()	将参数设置从文件加载到环境中
MDOwriteparams()	将参数设置序列化为文件
MDOresetparams()	将所有参数重置为其默认值

int MDOgetdblparam(MDOenv *env, const char *paramname, double *valueP)

检索double参数的值。

Parameters

• env (MDOenv*) – [in] 存储参数环境。

• paramname (const char*) – [in] 要检索的参数名称。

• valueP (double*) – [out] 保存参数值的位置。

Returns

指定函数状态的响应代码。

int MDOgetintparam(MDOenv *env, const char *paramname, int *valueP)

检索整数值参数的值。

Parameters

• env (MDOenv*) – [in] 保存参数的环境。

• paramname (const char*) – [in] 要检索的参数名称。

• valueP (int*) – [out] 保存参数值的位置。

Returns

指定函数状态的响应代码。

int MDOgetstrparam(MDOenv *env, const char *paramname, char *valueP)

检索字符串值参数的值。

Parameters

• env (MDOenv*) – [in] 保存参数的环境。

• paramname (const char*) – [in] 要检索的参数名称。

• valueP (char*) – [out] 保存参数值的位置。它应该有足够的容量 来存储结果字符串。

Returns

指定函数状态的响应代码。

int MDOsetdblparam(MDOenv *env, const char *paramname, double newvalue)

设置double参数的值。

Parameters

• env (MDOenv*) – [in] 参数holder环境。

• paramname (const char*) – [in] 要设置的参数名称。

• newvalue (double) – [out] 新的参数值。

Returns

指定函数状态的响应代码。

int MDOsetintparam(MDOenv *env, const char *paramname, int newvalue)

设置整数值参数的值。

Parameters

• env (MDOenv*) – [in] 保存参数环境。

• paramname (const char*) – [in] 要设置的参数名称。

• newvalue (int) – [out] 新的参数值。

Returns

指定函数状态的响应代码。

int MDOsetstrparam(MDOenv *env, const char *paramname, const char *newvalue)

设置字符串值参数的值。

Parameters

• env (MDOenv*) – [in] 保存参数的环境。

• paramname (const char*) – [in] 要设置的参数名称。

• newvalue (const char*) – [out] 新的参数值。

Returns

指定函数状态的响应代码。

int MDOgetdblparaminfo(MDOenv *env, const char *paramname, double *valueP, double *minP, double *maxP, double *defaultP)

检索信息和double参数的当前值。

Parameters

• env (MDOenv*) – [in] 保存参数的环境。

• paramname (const char*) – [in] 检索信息和值的参数名称。

• valueP (double*) – [out] 保存当前参数值的位置。

• minP (double*) – [out] 保存可接受的最小参数值的位置。

• maxP (double*) – [out] 保存可接受的最大参数值的位置。

• defaultP (double*) – [out] 保存以保存默认参数值的位置。

Returns

指定函数状态的响应代码。

int MDOgetintparaminfo(MDOenv *env, const char *paramname, int *valueP, int *minP, int *maxP, int *defaultP)

检索信息和整数值参数的当前值。

Parameters

• env (MDOenv*) – [in] 保存参数的环境。

• paramname (const char*) – [in] 检索信息和值的参数名称。

• valueP (int*) – [out] 保存以保存当前参数值的位置。

• minP (int*) – [out] 保存可接受的最小参数值的位置。

• maxP (int*) – [out] 保存可接受的最大参数值的位置。

• defaultP (int*) – [out] 保存以保存默认参数值的位置。

Returns

指定函数状态的响应代码。

int MDOgetstrparaminfo(MDOenv *env, const char *paramname, char *valueP, char *defaultP)

检索字符串值参数的信息和当前值。

Parameters

• env (MDOenv*) – [in] 保存参数的环境。

• paramname (const char*) – [in] 检索信息和值的参数名称。

• valueP (char*) – [out] 保存当前参数值的位置。它应该有足够的容量 来存储结果字符串。

• defaultP (char*) – [out] 保存默认参数值的位置。它应该有足够的容量 来存储结果字符串。

Returns

指定函数状态的响应代码。

int MDOreadparams(MDOenv *env, const char *filename)

将参数设置从文件加载到环境中。

Parameters

• env (MDOenv*) – [in] 环境指针。

• filename (const char*) – [in] 参数文件的路径。其压缩类型 (如果有) 应编码为其后缀。有效的后缀为:.gz和.bz2。

Returns

指定函数状态的响应代码。

int MDOwriteparams(MDOenv *env, const char *filename)

将参数设置序列化为文件。

Parameters

• env (MDOenv*) – [in] 环境指针。

• filename (const char*) – [in] 参数文件的路径。它的压缩类型 (如果有的话) 可以编码到它的后缀中。有效的后缀为:.gz和.bz2。

Returns

指定函数状态的响应代码。

void MDOresetparams(MDOenv *env)

将所有参数重置为其默认值。

Parameters

• env (MDOenv*) – [in] 环境指针。