prg_preference_transform_error_message_set()
摘要
设置一条描述自定义转换函数失败原因的消息。
语法
prg_preference_transform_error_message_set (data_ptr, error_message)
| 参数 | 类型 | 说明 |
|---|---|---|
data_ptr |
PrgT_Preference_Transform_Data * |
指向当前正在处理的转换的指针。 |
error message |
char * |
转换错误消息。 传入该消息之前必须为其分配新的内存,因为该函数将接管消息字符串的所有权并负责释放它。 |
返回类型
void
无返回值。
头文件
prg_env.h
示例
参见 prg_preference_transform_arguments_get() 的示例。
详情
可在自定义转换函数中使用此函数,设置一条描述转换失败原因的消息。该消息将出现在偏好迁移日志中该偏好的旁边。