All ITK functions of group PREF supported by T4x.
More...
|
| PREF_ask_char_values Scope Preference |
| This function calls the ITK pipe server function "PREF_ask_char_values" to read the values of a char-preference Note: starting from TC101 function "PREF_ask_char_values_at_location" should be preferred. More...
|
|
| PREF_ask_char_values_at_location Preference Location |
| This function calls the ITK pipe server function "PREF_ask_char_values_at_location" to read the values of a char-preference Note: starting from TC101 this function should be preferred to function "PREF_ask_char_values". More...
|
|
| PREF_ask_environment_set_flag Preference |
| This function calls the ITK pipe server function "PREF_ask_environment_set_flag" to read the value of the "environment set" flag. More...
|
|
| PREF_ask_environment_set_flag Preference Flag |
| This function calls the ITK pipe server function "PREF_set_environment_set_flag" to write the value of the "environment set" flag. More...
|
|
| PREF_ask_logical_value_for_scope Scope Preference ValueIndex |
| This function calls the ITK pipe server function "PREF_ask_logical_value" for a specific preference scope to read the logical value of a preference. More...
|
|
| PREF_delete_definition Count Preference1 ... PreferenceCount DeleteAllCustomDefinitions |
| This function calls the ITK pipe server function "PREF_delete_definition" to delete the definition of a preference. More...
|
|
| PREF_delete_preference Scope Preference |
| This function calls the ITK pipe server function "PREF_delete_preference" to delete a preference Note: starting from TC101 function "PREF_delete_preference_at_location" should be preferred. More...
|
|
| PREF_delete_preference_at_location Preference Location |
| This function calls the ITK pipe server function "PREF_delete_preference_at_location" to delete a preference Note: starting from TC101 this function should be preferred to function "PREF_delete_preference". More...
|
|
| PREF_export_preferences Scope XmlFilePath |
| This function calls the ITK pipe server function "PREF_export_preferences" to export an xml preference file. More...
|
|
| PREF_import_preferences Scope XmlFilePath Action |
| This function calls the ITK pipe server function "PREF_import_preferences" to import an xml preference file. More...
|
|
| PREF_set_char_values_at_location Preference Location Count args |
| This function calls the ITK pipe server function "PREF_set_char_values_at_location" to write the values of a char-preference Note: starting from TC101 this function should be preferred to function "PREF_set_char_values". More...
|
|
All ITK functions of group PREF supported by T4x.
This group specifies all ITK functions of group PREF for which wrappers have been defined in T4x
◆ PREF_ask_char_values()
ITK::PREF_ask_char_values |
|
|
Scope Preference |
|
|
| |
This function calls the ITK pipe server function "PREF_ask_char_values" to read the values of a char-preference Note: starting from TC101 function "PREF_ask_char_values_at_location" should be preferred.
- Parameters
-
Scope | scope of the preference Possible values:
|
Preference | hex encoded name of the preference |
- Returns
- List of ITK status and list of hex encoded values or optional error message
◆ PREF_ask_char_values_at_location()
ITK::PREF_ask_char_values_at_location |
|
|
Preference Location |
|
|
| |
This function calls the ITK pipe server function "PREF_ask_char_values_at_location" to read the values of a char-preference Note: starting from TC101 this function should be preferred to function "PREF_ask_char_values".
- Parameters
-
Preference | name of the preference |
Location | location of the preference Possible values:
|
- Returns
- List of ITK status and list of hex encoded values or optional error message
◆ PREF_ask_environment_set_flag() [1/2]
ITK::PREF_ask_environment_set_flag |
|
|
Preference |
|
|
| |
This function calls the ITK pipe server function "PREF_ask_environment_set_flag" to read the value of the "environment set" flag.
- Parameters
-
Preference | name of the preference |
- Returns
- List of ITK status and environment set value or optional error message
◆ PREF_ask_environment_set_flag() [2/2]
ITK::PREF_ask_environment_set_flag |
|
|
Preference Flag |
|
|
| |
This function calls the ITK pipe server function "PREF_set_environment_set_flag" to write the value of the "environment set" flag.
- Parameters
-
Preference | name of the preference |
Flag | environment set flag of the preference Possible values:
- true, True, TRUE, 1
- false, False, FALSE, 0
|
- Returns
- List of ITK status and optional error message
◆ PREF_ask_logical_value_for_scope()
ITK::PREF_ask_logical_value_for_scope |
|
|
Scope Preference ValueIndex |
|
|
| |
This function calls the ITK pipe server function "PREF_ask_logical_value" for a specific preference scope to read the logical value of a preference.
- Parameters
-
Scope | scope of the preference Possible values:
|
Preference | - hex encoded name of the preference |
ValueIndex | - index in the preference value array |
- Returns
- List of ITK status and 1|0 or optional error message
◆ PREF_delete_definition()
ITK::PREF_delete_definition |
|
|
Count Preference1 ... PreferenceCount DeleteAllCustomDefinitions |
|
|
| |
This function calls the ITK pipe server function "PREF_delete_definition" to delete the definition of a preference.
- Parameters
-
Count | number of preference names |
Preference1 | ... PreferenceCount preference names |
DeleteAllCustomDefinitions | - if all custom definitions have to be deleted or only those for the specified preferences Possible values:
- true, True, TRUE, 1
- false, False, FALSE, 0 If set to "true", then parameter "Count" has to be set to "0" and no preference name has to be specified
|
- Returns
- List of ITK status and optional error message
◆ PREF_delete_preference()
ITK::PREF_delete_preference |
|
|
Scope Preference |
|
|
| |
This function calls the ITK pipe server function "PREF_delete_preference" to delete a preference Note: starting from TC101 function "PREF_delete_preference_at_location" should be preferred.
- Parameters
-
Scope | - scope of the preference Possible values:
|
Preference | name of the preference |
- Returns
- List of ITK status and optional error message
◆ PREF_delete_preference_at_location()
ITK::PREF_delete_preference_at_location |
|
|
Preference Location |
|
|
| |
This function calls the ITK pipe server function "PREF_delete_preference_at_location" to delete a preference Note: starting from TC101 this function should be preferred to function "PREF_delete_preference".
- Parameters
-
Preference | name of the preference |
Location | - location of the preference Possible values:
|
- Returns
- List of ITK status and optional error message
◆ PREF_export_preferences()
ITK::PREF_export_preferences |
|
|
Scope XmlFilePath |
|
|
| |
This function calls the ITK pipe server function "PREF_export_preferences" to export an xml preference file.
- Parameters
-
Scope | scope of the preferences Possible values:
|
XmlFilePath | file path of the xml file |
- Returns
- List of ITK status and optional error message
◆ PREF_import_preferences()
ITK::PREF_import_preferences |
|
|
Scope XmlFilePath Action |
|
|
| |
This function calls the ITK pipe server function "PREF_import_preferences" to import an xml preference file.
- Parameters
-
Scope | scope of the preferences Possible values:
|
XmlFilePath | file path of the xml file |
Action | merge action Possible values:
|
- Returns
- List of ITK status and optional error message
◆ PREF_set_char_values_at_location()
ITK::PREF_set_char_values_at_location |
|
|
Preference Location Count args |
|
|
| |
This function calls the ITK pipe server function "PREF_set_char_values_at_location" to write the values of a char-preference Note: starting from TC101 this function should be preferred to function "PREF_set_char_values".
- Parameters
-
Preference | name of the preference |
Location | location of the preference Possible values:
|
Count | number of values of the preference |
args | values of the preference |
- Returns
- List of ITK status and optional error message