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.
Header
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.