PrgT_Preference_Transform_Function
Abstract
Callback: Used to define a custom transformation function.
Syntax
<transformation function name> (data_ptr)
| Argument | Type | Description |
|---|---|---|
data_ptr |
PrgT_Preference_Transform_Data * |
User-defined data that is passed to the callback. |
Return Type
PrgT_Preference_Transform_Status
Status of transformation.
Header
prg_env.h
Example
See example for prg_preference_transform_arguments_get().
Details
The arguments to the transformation function in the delta block are optional. However, the function itself is always expected to take in one argument and return a value indicating the status of the transformation.
Possible status codes that can be returned by a preference transformation function are:
PrgC_Preference_Transform_Status_SuccessPrgC_Preference_Transform_Status_Do_Not_MigratePrgC_Preference_Transform_Status_Failure