prg_preference_transform_error_message_set()

Abstract

Sets a message describing the cause of a failure in a custom transformation function.

Syntax

prg_preference_transform_error_message_set (data_ptr, error_message)
Argument Type Description
data_ptr PrgT_Preference_Transform_Data * Pointer to the applicable transformation being acted upon.
error message char * The transformation error message.
You must allocate new memory for the message before passing it into the function, since the function will take ownership of the message string and deallocate it.

Return Type

void

No return value.

prg_env.h

Example

See example for prg_preference_transform_arguments_get().

Details

You can use this function in a custom transformation function to set a message describing the cause of a transformation failure. The message will appear next to the preference in the Preferences Migration log.

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com