Adaptive Framework  0.9.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Functions | Variables

Functions

const afw_value_tafw_function_execute_add_string (afw_function_execute_t *x)
 Adaptive Function add<string> More...
 
const afw_value_tafw_function_execute_concat (afw_function_execute_t *x)
 Adaptive Function concat More...
 
const afw_value_tafw_function_execute_eq_ignore_case_string (afw_function_execute_t *x)
 Adaptive Function eq_ignore_case<string> More...
 
const afw_value_tafw_function_execute_normalize_space_string (afw_function_execute_t *x)
 Adaptive Function normalize_space<string> More...
 
const afw_value_tafw_function_execute_normalize_to_lower_case_string (afw_function_execute_t *x)
 Adaptive Function normalize_to_lower_case<string> More...
 
const afw_value_tafw_function_execute_string (afw_function_execute_t *x)
 Adaptive Function string More...
 
const afw_value_tafw_function_execute_url_decode (afw_function_execute_t *x)
 Adaptive Function url_decode More...
 

Variables

 afw_function_definition_add_string
 Function definition add<string>
 
 afw_function_definition_at_least_one_member_of_string
 Function definition at_least_one_member_of<string>
 
 afw_function_definition_bag_size_string
 Adaptive Function at_least_one_member_of<string> More...
 
 afw_function_definition_bag_string
 Adaptive Function bag_size<string> More...
 
 afw_function_definition_concat
 Adaptive Function bag<string> More...
 
 afw_function_definition_encode_as_base64Binary_string
 Function definition encode_as_base64Binary<string>
 
 afw_function_definition_encode_as_hexBinary_string
 Adaptive Function encode_as_base64Binary<string> More...
 
 afw_function_definition_ends_with_string
 Adaptive Function encode_as_hexBinary<string> More...
 
 afw_function_definition_eq_ignore_case_string
 Adaptive Function ends_with<string> More...
 
 afw_function_definition_eq_string
 Function definition eq<string>
 
 afw_function_definition_eqx_string
 Adaptive Function eq<string> More...
 
 afw_function_definition_ge_string
 Adaptive Function eqx<string> More...
 
 afw_function_definition_gt_string
 Adaptive Function ge<string> More...
 
 afw_function_definition_includes_string
 Adaptive Function gt<string> More...
 
 afw_function_definition_index_of_string
 Adaptive Function includes<string> More...
 
 afw_function_definition_intersection_string
 Adaptive Function index_of<string> More...
 
 afw_function_definition_is_in_string
 Adaptive Function intersection<string> More...
 
 afw_function_definition_is_string
 Adaptive Function is_in<string> More...
 
 afw_function_definition_last_index_of_string
 Adaptive Function is<string> More...
 
 afw_function_definition_le_string
 Adaptive Function last_index_of<string> More...
 
 afw_function_definition_length_string
 Adaptive Function le<string> More...
 
 afw_function_definition_lt_string
 Adaptive Function length<string> More...
 
 afw_function_definition_max_string
 Adaptive Function lt<string> More...
 
 afw_function_definition_min_string
 Adaptive Function max<string> More...
 
 afw_function_definition_ne_string
 Adaptive Function min<string> More...
 
 afw_function_definition_nex_string
 Adaptive Function ne<string> More...
 
 afw_function_definition_normalize_space_string
 Adaptive Function nex<string> More...
 
 afw_function_definition_normalize_to_lower_case_string
 Function definition normalize_to_lower_case<string>
 
 afw_function_definition_one_and_only_string
 Function definition one_and_only<string>
 
 afw_function_definition_regexp_index_of_string
 Adaptive Function one_and_only<string> More...
 
 afw_function_definition_regexp_match_string
 Adaptive Function regexp_index_of<string> More...
 
 afw_function_definition_regexp_replace_string
 Adaptive Function regexp_match<string> More...
 
 afw_function_definition_repeat_string
 Adaptive Function regexp_replace<string> More...
 
 afw_function_definition_replace_string
 Adaptive Function repeat<string> More...
 
 afw_function_definition_set_equals_string
 Adaptive Function replace<string> More...
 
 afw_function_definition_split_string
 Adaptive Function set_equals<string> More...
 
 afw_function_definition_starts_with_string
 Adaptive Function split<string> More...
 
 afw_function_definition_string
 Adaptive Function starts_with<string> More...
 
 afw_function_definition_subset_string
 Function definition subset<string>
 
 afw_function_definition_substring_string
 Adaptive Function subset<string> More...
 
 afw_function_definition_to_anyURI_string
 Adaptive Function substring<string> More...
 
 afw_function_definition_to_boolean_string
 Adaptive Function to_anyURI<string> More...
 
 afw_function_definition_to_dateTime_string
 Adaptive Function to_boolean<string> More...
 
 afw_function_definition_to_date_string
 Adaptive Function to_dateTime<string> More...
 
 afw_function_definition_to_dayTimeDuration_string
 Adaptive Function to_date<string> More...
 
 afw_function_definition_to_dnsName_string
 Adaptive Function to_dayTimeDuration<string> More...
 
 afw_function_definition_to_double_string
 Adaptive Function to_dnsName<string> More...
 
 afw_function_definition_to_integer_string
 Adaptive Function to_double<string> More...
 
 afw_function_definition_to_ipAddress_string
 Adaptive Function to_integer<string> More...
 
 afw_function_definition_to_rfc822Name_string
 Adaptive Function to_ipAddress<string> More...
 
 afw_function_definition_to_string_string
 Adaptive Function to_rfc822Name<string> More...
 
 afw_function_definition_to_time_string
 Adaptive Function to_string<string> More...
 
 afw_function_definition_to_x500Name_string
 Adaptive Function to_time<string> More...
 
 afw_function_definition_to_yearMonthDuration_string
 Adaptive Function to_x500Name<string> More...
 
 afw_function_definition_union_string
 Adaptive Function to_yearMonthDuration<string> More...
 
 afw_function_definition_url_decode
 Adaptive Function union<string> More...
 
 afw_function_definition_url_encode_string
 Function definition url_encode<string>
 

Detailed Description

string adaptive functions.

Function Documentation

◆ afw_function_execute_add_string()

const afw_value_t* afw_function_execute_add_string ( afw_function_execute_t x)

Adaptive Function add<string>

Parameters
xfunction execute parameter.

Add (concatenate) 2 or more string values and return the string result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function add<string>(
values_1: string,
values_2: string,
...values_rest: (list of string)
): string;

Parameters:

values - (2 or more string)

Returns:

(string)

Definition at line 49 of file afw_function_string.c.

◆ afw_function_execute_concat()

const afw_value_t* afw_function_execute_concat ( afw_function_execute_t x)

Adaptive Function concat

Parameters
xfunction execute parameter.

Convert two or more values of any data type to string and return the concatenated result. A value with an undefined value is represented by <undefined>.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function concat(
values_1: any,
...values_rest: (list of any)
): string;

Parameters:

values - (1 or more any dataType) Value to convert.

Returns:

(string) The concatenated string values.

Errors thrown:

cast_error - value could not be converted

Definition at line 126 of file afw_function_string.c.

◆ afw_function_execute_eq_ignore_case_string()

const afw_value_t* afw_function_execute_eq_ignore_case_string ( afw_function_execute_t x)

Adaptive Function eq_ignore_case<string>

Parameters
xfunction execute parameter.

Checks for string arg1 is equal to string arg2 ignoring case and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function eq_ignore_case<string>(
arg1: string,
arg2: string
): boolean;

Parameters:

arg1 - (string)

arg2 - (string)

Returns:

(boolean)

Definition at line 199 of file afw_function_string.c.

◆ afw_function_execute_normalize_space_string()

const afw_value_t* afw_function_execute_normalize_space_string ( afw_function_execute_t x)

Adaptive Function normalize_space<string>

Parameters
xfunction execute parameter.

Remove whitespace from the beginning and end of a string value.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function normalize_space<string>(
string: string
): string;

Parameters:

string - (string)

Returns:

(string)

Definition at line 246 of file afw_function_string.c.

◆ afw_function_execute_normalize_to_lower_case_string()

const afw_value_t* afw_function_execute_normalize_to_lower_case_string ( afw_function_execute_t x)

Adaptive Function normalize_to_lower_case<string>

Parameters
xfunction execute parameter.

Normalize string value to lower case and returns string result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function normalize_to_lower_case<string>(
string: string
): string;

Parameters:

string - (string)

Returns:

(string)

Definition at line 291 of file afw_function_string.c.

◆ afw_function_execute_string()

const afw_value_t* afw_function_execute_string ( afw_function_execute_t x)

Adaptive Function string

Parameters
xfunction execute parameter.

Convert one or more values of any data type to string and return the concatenated result. A value with an undefined value is represented by <undefined>.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function string(
values_1: any,
...values_rest: (list of any)
): string;

Parameters:

values - (1 or more any dataType) Value to convert.

Returns:

(string) The concatenated string values.

Errors thrown:

cast_error - value could not be converted

Definition at line 343 of file afw_function_string.c.

◆ afw_function_execute_url_decode()

const afw_value_t* afw_function_execute_url_decode ( afw_function_execute_t x)

Adaptive Function url_decode

Parameters
xfunction execute parameter.

URL decode a value or bag of values.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function url_decode(
encoded: string
): string;

Parameters:

encoded - (string) URL decode a single string or a bag of string.

Returns:

(string) A string or bag of strings.

Todo:
should this be here or in anyURI?.

Definition at line 412 of file afw_function_string.c.

Variable Documentation

◆ afw_function_definition_bag_size_string

afw_function_definition_bag_size_string

Adaptive Function at_least_one_member_of<string>

Parameters
xfunction execute parameter.

Returns boolean true if at least one value in string list1 is in string list2.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function at_least_one_member_of<string>(
list1: (list string),
list2: (list string)
): boolean;

Parameters:

list1 - (list string) The first list.

list2 - (list string) The second list.

Returns:

(boolean)

Implemented by afw_function_execute_at_least_one_member_of()


Function definition bag_size<string>

Definition at line 26850 of file afw_function_bindings.h.

◆ afw_function_definition_bag_string

afw_function_definition_bag_string

Adaptive Function bag_size<string>

Parameters
xfunction execute parameter.

This returns the integer number of values in list.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function bag_size<string>(
value: (list string)
): integer;

Parameters:

value - (list string)

Returns:

(integer)

Implemented by afw_function_execute_bag_size()


Function definition bag<string>

Definition at line 26884 of file afw_function_bindings.h.

◆ afw_function_definition_concat

afw_function_definition_concat

Adaptive Function bag<string>

Parameters
xfunction execute parameter.

Takes any number of string values and returns a list of list.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function bag<string>(
...values: (list of (list string))
): (list string);

Parameters:

values - (0 or more list string)

Returns:

(list string)

Implemented by afw_function_execute_bag()


Function definition concat

Definition at line 26918 of file afw_function_bindings.h.

◆ afw_function_definition_encode_as_hexBinary_string

afw_function_definition_encode_as_hexBinary_string

Adaptive Function encode_as_base64Binary<string>

Parameters
xfunction execute parameter.

Encode a value as a base64Binary. The effect is to create a base64Binary value with an internal value of the value passed.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function encode_as_base64Binary<string>(
value: string
): base64Binary;

Parameters:

value - (string) The string value to encode.

Returns:

(base64Binary) A base64Binary value.

Implemented by afw_function_execute_encode_as_base64Binary()


Function definition encode_as_hexBinary<string>

Definition at line 26993 of file afw_function_bindings.h.

◆ afw_function_definition_ends_with_string

afw_function_definition_ends_with_string

Adaptive Function encode_as_hexBinary<string>

Parameters
xfunction execute parameter.

Encode a value as a hexBinary. The effect is to create a hexBinary value with an internal value of the value passed.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function encode_as_hexBinary<string>(
value: string
): hexBinary;

Parameters:

value - (string) The string value to encode.

Returns:

(hexBinary) A hexBinary value.

Implemented by afw_function_execute_encode_as_hexBinary()


Function definition ends_with<string>

Definition at line 27028 of file afw_function_bindings.h.

◆ afw_function_definition_eq_ignore_case_string

afw_function_definition_eq_ignore_case_string

Adaptive Function ends_with<string>

Parameters
xfunction execute parameter.

Checks whether string value ends with a string and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function ends_with<string>(
value: string,
subString: string
): boolean;

Parameters:

value - (string)

subString - (string)

Returns:

(boolean)

Implemented by afw_function_execute_ends_with()


Function definition eq_ignore_case<string>

Definition at line 27066 of file afw_function_bindings.h.

◆ afw_function_definition_eqx_string

afw_function_definition_eqx_string

Adaptive Function eq<string>

Parameters
xfunction execute parameter.

Determine if string arg1 is equal to the value of arg2 converted to the data type of arg1 then return the boolean result. Use "eqx" ("===") instead if you want false to be returned if arg1 and arg2's data type don't match.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function eq<string>(
arg1: string,
arg2: any
): boolean;

Parameters:

arg1 - (string)

arg2 - (any dataType)

Returns:

(boolean)

Errors thrown:

conversion - arg2 cannot be converted to the data type of arg1.

Implemented by afw_function_execute_eq()


Function definition eqx<string>

Definition at line 27146 of file afw_function_bindings.h.

◆ afw_function_definition_ge_string

afw_function_definition_ge_string

Adaptive Function eqx<string>

Parameters
xfunction execute parameter.

Determine if for string arg1 is equal to the value and data type of arg2 then return the boolean result. Use "eq" ("==") instead if you want arg2 to be converted to the data type of arg1 before comparison.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function eqx<string>(
arg1: string,
arg2: any
): boolean;

Parameters:

arg1 - (string)

arg2 - (any dataType)

Returns:

(boolean)

Implemented by afw_function_execute_eqx()


Function definition ge<string>

Definition at line 27185 of file afw_function_bindings.h.

◆ afw_function_definition_gt_string

afw_function_definition_gt_string

Adaptive Function ge<string>

Parameters
xfunction execute parameter.

Checks for string arg1 is greater than or equal to string arg2 and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function ge<string>(
arg1: string,
arg2: string
): boolean;

Parameters:

arg1 - (string)

arg2 - (string)

Returns:

(boolean)

Implemented by afw_function_execute_ge()


Function definition gt<string>

Definition at line 27223 of file afw_function_bindings.h.

◆ afw_function_definition_includes_string

afw_function_definition_includes_string

Adaptive Function gt<string>

Parameters
xfunction execute parameter.

Checks for string arg1 is greater than string arg2 and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function gt<string>(
arg1: string,
arg2: string
): boolean;

Parameters:

arg1 - (string)

arg2 - (string)

Returns:

(boolean)

Implemented by afw_function_execute_gt()


Function definition includes<string>

Definition at line 27261 of file afw_function_bindings.h.

◆ afw_function_definition_index_of_string

afw_function_definition_index_of_string

Adaptive Function includes<string>

Parameters
xfunction execute parameter.

Checks whether the string value includes a string and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function includes<string>(
searchString: string,
subString: string,
position?: integer
): boolean;

Parameters:

searchString - (string) The string to search.

subString - (string) Substring to find.

position - (optional integer) Zero-based position in the search string to start search.

Returns:

(boolean) Indicates if the substring is contained in the search string.

Implemented by afw_function_execute_includes()


Function definition index_of<string>

Definition at line 27303 of file afw_function_bindings.h.

◆ afw_function_definition_intersection_string

afw_function_definition_intersection_string

Adaptive Function index_of<string>

Parameters
xfunction execute parameter.

Returns the zero-based index into string value of subString. If subString is not found, -1 is returned.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function index_of<string>(
value: string,
subString: string,
startIndex?: integer
): integer;

Parameters:

value - (string) The string value to search.

subString - (string) Substring to search for.

startIndex - (optional integer) Optional start index for search if different than start of string.

Returns:

(integer) Zero-based index of subString or -1 if not found.

Implemented by afw_function_execute_index_of()


Function definition intersection<string>

Definition at line 27345 of file afw_function_bindings.h.

◆ afw_function_definition_is_in_string

afw_function_definition_is_in_string

Adaptive Function intersection<string>

Parameters
xfunction execute parameter.

Returns a list of string with the values that are common to both list of string list1 and list2.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function intersection<string>(
list1: (list string),
list2: (list string)
): (list string);

Parameters:

list1 - (list string) The first list.

list2 - (list string) The second list.

Returns:

(list string)

Implemented by afw_function_execute_intersection()


Function definition is_in<string>

Definition at line 27383 of file afw_function_bindings.h.

◆ afw_function_definition_is_string

afw_function_definition_is_string

Adaptive Function is_in<string>

Parameters
xfunction execute parameter.

Checks whether string value is in list of string list and returns the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function is_in<string>(
value: string,
list: (list string)
): boolean;

Parameters:

value - (string)

list - (list string)

Returns:

(boolean)

Implemented by afw_function_execute_is_in()


Function definition is<string>

Definition at line 27421 of file afw_function_bindings.h.

◆ afw_function_definition_last_index_of_string

afw_function_definition_last_index_of_string

Adaptive Function is<string>

Parameters
xfunction execute parameter.

Checks whether value is dataType string and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function is<string>(
value: any
): boolean;

Parameters:

value - (any dataType) Value to check.

Returns:

(boolean)

Implemented by afw_function_execute_is()


Function definition last_index_of<string>

Definition at line 27455 of file afw_function_bindings.h.

◆ afw_function_definition_le_string

afw_function_definition_le_string

Adaptive Function last_index_of<string>

Parameters
xfunction execute parameter.

Returns the zero-based index into string value of the last occurrence of a subString. If subString is not found, -1 is returned.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function last_index_of<string>(
value: string,
subString: string,
startIndex?: integer
): integer;

Parameters:

value - (string) The string value to search.

subString - (string) Substring to search for.

startIndex - (optional integer) Optional start index for search if different than start of string.

Returns:

(integer) Zero-based index of subString or -1 if not found.

Implemented by afw_function_execute_last_index_of()


Function definition le<string>

Definition at line 27497 of file afw_function_bindings.h.

◆ afw_function_definition_length_string

afw_function_definition_length_string

Adaptive Function le<string>

Parameters
xfunction execute parameter.

Checks for string arg1 is less than or equal to string arg2 and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function le<string>(
arg1: string,
arg2: any
): boolean;

Parameters:

arg1 - (string)

arg2 - (any dataType)

Returns:

(boolean)

Implemented by afw_function_execute_le()


Function definition length<string>

Definition at line 27535 of file afw_function_bindings.h.

◆ afw_function_definition_lt_string

afw_function_definition_lt_string

Adaptive Function length<string>

Parameters
xfunction execute parameter.

This is a polymorphic function where string can be any of the supported data types. Return the integer number of entries in datatype list or codepoints in others.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function length<string>(
value: string
): integer;

Parameters:

value - (string) Returns the number of entries in a list or code points in others.

Returns:

(integer)

Implemented by afw_function_execute_length()


Function definition lt<string>

Definition at line 27572 of file afw_function_bindings.h.

◆ afw_function_definition_max_string

afw_function_definition_max_string

Adaptive Function lt<string>

Parameters
xfunction execute parameter.

Checks for string arg1 is less that string arg2 and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function lt<string>(
arg1: string,
arg2: string
): boolean;

Parameters:

arg1 - (string)

arg2 - (string)

Returns:

(boolean)

Implemented by afw_function_execute_lt()


Function definition max<string>

Definition at line 27610 of file afw_function_bindings.h.

◆ afw_function_definition_min_string

afw_function_definition_min_string

Adaptive Function max<string>

Parameters
xfunction execute parameter.

Return the string value that is greater than or equal to the others.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function max<string>(
values_1: string,
...values_rest: (list of string)
): string;

Parameters:

values - (1 or more string)

Returns:

(string)

Implemented by afw_function_execute_max()


Function definition min<string>

Definition at line 27645 of file afw_function_bindings.h.

◆ afw_function_definition_ne_string

afw_function_definition_ne_string

Adaptive Function min<string>

Parameters
xfunction execute parameter.

Return the string value that is less than or equal to the others.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function min<string>(
values_1: string,
...values_rest: (list of string)
): string;

Parameters:

values - (1 or more string)

Returns:

(string)

Implemented by afw_function_execute_min()


Function definition ne<string>

Definition at line 27680 of file afw_function_bindings.h.

◆ afw_function_definition_nex_string

afw_function_definition_nex_string

Adaptive Function ne<string>

Parameters
xfunction execute parameter.

Determine if string arg1 is not equal to the value of arg2 converted to the data type of arg1 then return the boolean result. Use "nex" ("!==") instead if you want true to be returned if arg1 and arg2's data type don't match.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function ne<string>(
arg1: string,
arg2: any
): boolean;

Parameters:

arg1 - (string)

arg2 - (any dataType)

Returns:

(boolean)

Errors thrown:

conversion - arg2 cannot be converted to the data type of arg1.

Implemented by afw_function_execute_ne()


Function definition nex<string>

Definition at line 27723 of file afw_function_bindings.h.

◆ afw_function_definition_normalize_space_string

afw_function_definition_normalize_space_string

Adaptive Function nex<string>

Parameters
xfunction execute parameter.

Determine if for string arg1 is not equal to the value or data type of arg2 then return the boolean result. Use "ne" ("!=") instead if you want arg2 to be converted to the data type of arg1 before comparison.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function nex<string>(
arg1: string,
arg2: any
): boolean;

Parameters:

arg1 - (string)

arg2 - (any dataType)

Returns:

(boolean)

Implemented by afw_function_execute_nex()


Function definition normalize_space<string>

Definition at line 27762 of file afw_function_bindings.h.

◆ afw_function_definition_regexp_index_of_string

afw_function_definition_regexp_index_of_string

Adaptive Function one_and_only<string>

Parameters
xfunction execute parameter.

This converts a list of string values that contains one value to a single string value.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function one_and_only<string>(
list: (list list)
): string;

Parameters:

list - (list list)

Returns:

(string)

Errors thrown:

arg_error - list does not contain exactly one value

Implemented by afw_function_execute_one_and_only()


Function definition regexp_index_of<string>

Definition at line 27867 of file afw_function_bindings.h.

◆ afw_function_definition_regexp_match_string

afw_function_definition_regexp_match_string

Adaptive Function regexp_index_of<string>

Parameters
xfunction execute parameter.

Search string value for a regular expression and return index. If not found, -1 is returned.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function regexp_index_of<string>(
value: string,
regexp: string
): integer;

Parameters:

value - (string) The string value to search.

regexp - (string) A regular expression to use for search.

Returns:

(integer) Zero-based index of subString or -1 if not found.

Implemented by afw_function_execute_regexp_index_of()


Function definition regexp_match<string>

Definition at line 27905 of file afw_function_bindings.h.

◆ afw_function_definition_regexp_replace_string

afw_function_definition_regexp_replace_string

Adaptive Function regexp_match<string>

Parameters
xfunction execute parameter.

Checks whether string value matches the regular expression regexp and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function regexp_match<string>(
value: string,
regexp: string
): boolean;

Parameters:

value - (string)

regexp - (string)

Returns:

(boolean)

Implemented by afw_function_execute_regexp_match()


Function definition regexp_replace<string>

Definition at line 27943 of file afw_function_bindings.h.

◆ afw_function_definition_repeat_string

afw_function_definition_repeat_string

Adaptive Function regexp_replace<string>

Parameters
xfunction execute parameter.

Replace matched values for a regular expression in a string value.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function regexp_replace<string>(
value: string,
regexp: string,
replacement: string,
limit?: integer
): string;

Parameters:

value - (string) The original string value.

regexp - (string) A regular expression to use for search.

replacement - (string) The replacement string.

limit - (optional integer) This is the maximum times to replace. The default is 1. Specify -1 to replace all occurrences.

Returns:

(string) A string value with the matched string(s) replaced.

Implemented by afw_function_execute_regexp_replace()


Function definition repeat<string>

Definition at line 27987 of file afw_function_bindings.h.

◆ afw_function_definition_replace_string

afw_function_definition_replace_string

Adaptive Function repeat<string>

Parameters
xfunction execute parameter.

Repeat a string value a specified number of times.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function repeat<string>(
value: string,
times: integer
): string;

Parameters:

value - (string) The string value to repeat.

times - (integer) The number of times to repeat the value.

Returns:

(string) The repeated string value.

Implemented by afw_function_execute_repeat()


Function definition replace<string>

Definition at line 28024 of file afw_function_bindings.h.

◆ afw_function_definition_set_equals_string

afw_function_definition_set_equals_string

Adaptive Function replace<string>

Parameters
xfunction execute parameter.

Replace string(s) in a string value.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function replace<string>(
value: string,
match: string,
replacement: string,
limit?: integer
): string;

Parameters:

value - (string) The original string value.

match - (string) The string to replace.

replacement - (string) The replacement string.

limit - (optional integer) This is the maximum times to replace. The default is 1. Specify -1 to replace all occurrences.

Returns:

(string) A string value with the matched string(s) replaced.

Implemented by afw_function_execute_replace()


Function definition set_equals<string>

Definition at line 28068 of file afw_function_bindings.h.

◆ afw_function_definition_split_string

afw_function_definition_split_string

Adaptive Function set_equals<string>

Parameters
xfunction execute parameter.

Returns boolean true if string list1 and string list2 are subsets of each other and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function set_equals<string>(
list1: (list string),
list2: (list string)
): boolean;

Parameters:

list1 - (list string)

list2 - (list string)

Returns:

(boolean)

Implemented by afw_function_execute_set_equals()


Function definition split<string>

Definition at line 28106 of file afw_function_bindings.h.

◆ afw_function_definition_starts_with_string

afw_function_definition_starts_with_string

Adaptive Function split<string>

Parameters
xfunction execute parameter.

Split string value into an list of strings using a separator.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function split<string>(
value: string,
separator?: string,
limit?: integer
): list;

Parameters:

value - (string) The string value to split.

separator - (optional string) The separator to use. If this is an empty string or separator is not specified, the value is split between characters.

limit - (optional integer) This is the maximum number of splits. Any remaining part of value is ignored.

Returns:

(list) An list of strings.

Implemented by afw_function_execute_split()


Function definition starts_with<string>

Definition at line 28149 of file afw_function_bindings.h.

◆ afw_function_definition_string

afw_function_definition_string

Adaptive Function starts_with<string>

Parameters
xfunction execute parameter.

Checks whether string value starts with a subString and return the boolean result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function starts_with<string>(
value: string,
subString: string
): boolean;

Parameters:

value - (string)

subString - (string)

Returns:

(boolean)

Implemented by afw_function_execute_starts_with()


Function definition string

Definition at line 28187 of file afw_function_bindings.h.

◆ afw_function_definition_substring_string

afw_function_definition_substring_string

Adaptive Function subset<string>

Parameters
xfunction execute parameter.

Returns boolean true if the unique values in string list1 are all in string list2.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function subset<string>(
list1: (list string),
list2: (list string)
): boolean;

Parameters:

list1 - (list string) The first list.

list2 - (list string) The second list.

Returns:

(boolean)

Implemented by afw_function_execute_subset()


Function definition substring<string>

Definition at line 28265 of file afw_function_bindings.h.

◆ afw_function_definition_to_anyURI_string

afw_function_definition_to_anyURI_string

Adaptive Function substring<string>

Parameters
xfunction execute parameter.

Returns the string substring of value beginning at zero-based position integer startIndex and ending at the position before integer endIndex. Specify -1 or omitting endIndex to return up to end of string.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function substring<string>(
string: string,
startIndex: integer,
endIndex?: integer
): string;

Parameters:

string - (string)

startIndex - (integer)

endIndex - (optional integer)

Returns:

(string)

Errors thrown:

arg_error - startIndex or endIndex is out of range

Implemented by afw_function_execute_substring()


Function definition to_anyURI<string>

Definition at line 28311 of file afw_function_bindings.h.

◆ afw_function_definition_to_boolean_string

afw_function_definition_to_boolean_string

Adaptive Function to_anyURI<string>

Parameters
xfunction execute parameter.

Converts string value to anyURI.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function to_anyURI<string>(
value: string
): anyURI;

Parameters:

value - (string)

Returns:

(anyURI)

Errors thrown:

cast_error - value could not be converted

Implemented by afw_function_execute_convert()


Function definition to_boolean<string>

Definition at line 28349 of file afw_function_bindings.h.

◆ afw_function_definition_to_date_string

afw_function_definition_to_date_string

Adaptive Function to_dateTime<string>

Parameters
xfunction execute parameter.

Converts string value to dateTime.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function to_dateTime<string>(
value: string
): dateTime;

Parameters:

value - (string)

Returns:

(dateTime)

Errors thrown:

cast_error - value could not be converted

Implemented by afw_function_execute_convert()


Function definition to_date<string>

Definition at line 28425 of file afw_function_bindings.h.

◆ afw_function_definition_to_dateTime_string

afw_function_definition_to_dateTime_string

Adaptive Function to_boolean<string>

Parameters
xfunction execute parameter.

Converts string value to boolean.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function to_boolean<string>(
value: string
): boolean;

Parameters:

value - (string)

Returns:

(boolean)

Errors thrown:

cast_error - value could not be converted

Implemented by afw_function_execute_convert()


Function definition to_dateTime<string>

Definition at line 28387 of file afw_function_bindings.h.

◆ afw_function_definition_to_dayTimeDuration_string

afw_function_definition_to_dayTimeDuration_string

Adaptive Function to_date<string>

Parameters
xfunction execute parameter.

Converts string value to date.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function to_date<string>(
value: string
): date;

Parameters:

value - (string)

Returns:

(date)

Errors thrown:

cast_error - value could not be converted

Implemented by afw_function_execute_convert()


Function definition to_dayTimeDuration<string>

Definition at line 28463 of file afw_function_bindings.h.

◆ afw_function_definition_to_dnsName_string

afw_function_definition_to_dnsName_string

Adaptive Function to_dayTimeDuration<string>

Parameters
xfunction execute parameter.

Converts string value to dayTimeDuration.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function to_dayTimeDuration<string>(
value: string
): dayTimeDuration;

Parameters:

value - (string)

Returns:

(dayTimeDuration)

Errors thrown:

cast_error - value could not be converted

Implemented by afw_function_execute_convert()


Function definition to_dnsName<string>

Definition at line 28501 of file afw_function_bindings.h.

◆ afw_function_definition_to_double_string

afw_function_definition_to_double_string

Adaptive Function to_dnsName<string>

Parameters
xfunction execute parameter.

Converts string value to dnsName.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function to_dnsName<string>(
value: string
): dnsName;

Parameters:

value - (string)

Returns:

(dnsName)

Errors thrown:

cast_error - value could not be converted

Implemented by afw_function_execute_convert()


Function definition to_double<string>

Definition at line 28539 of file afw_function_bindings.h.

◆ afw_function_definition_to_integer_string

afw_function_definition_to_integer_string

Adaptive Function to_double<string>

Parameters
xfunction execute parameter.

Converts string value to double and returns double result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function to_double<string>(
value: string
): double;

Parameters:

value - (string)

Returns:

(double)

Errors thrown:

cast_error - value could not be converted

Implemented by afw_function_execute_convert()


Function definition to_integer<string>

Definition at line 28577 of file afw_function_bindings.h.

◆ afw_function_definition_to_ipAddress_string

afw_function_definition_to_ipAddress_string

Adaptive Function to_integer<string>

Parameters
xfunction execute parameter.

Truncate string value to a whole number and returns integer result.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function to_integer<string>(
value: string
): integer;

Parameters:

value - (string)

Returns:

(integer)

Implemented by afw_function_execute_convert()


Function definition to_ipAddress<string>

Definition at line 28611 of file afw_function_bindings.h.

◆ afw_function_definition_to_rfc822Name_string

afw_function_definition_to_rfc822Name_string

Adaptive Function to_ipAddress<string>

Parameters
xfunction execute parameter.

Converts string value to ipAddress.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function to_ipAddress<string>(
value: string
): ipAddress;

Parameters:

value - (string)

Returns:

(ipAddress)

Errors thrown:

cast_error - value could not be converted

Implemented by afw_function_execute_convert()


Function definition to_rfc822Name<string>

Definition at line 28649 of file afw_function_bindings.h.

◆ afw_function_definition_to_string_string

afw_function_definition_to_string_string

Adaptive Function to_rfc822Name<string>

Parameters
xfunction execute parameter.

Converts string value to rfc822Name.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function to_rfc822Name<string>(
value: string
): rfc822Name;

Parameters:

value - (string)

Returns:

(rfc822Name)

Errors thrown:

cast_error - value could not be converted

Implemented by afw_function_execute_convert()


Function definition to_string<string>

Definition at line 28687 of file afw_function_bindings.h.

◆ afw_function_definition_to_time_string

afw_function_definition_to_time_string

Adaptive Function to_string<string>

Parameters
xfunction execute parameter.

Converts string value to string. For list values, the to_string() value for each entry is returned separated with commas.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function to_string<string>(
value: string
): string;

Parameters:

value - (string) A string value.

Returns:

(string) The string representation of the value.

Implemented by afw_function_execute_convert()


Function definition to_time<string>

Definition at line 28722 of file afw_function_bindings.h.

◆ afw_function_definition_to_x500Name_string

afw_function_definition_to_x500Name_string

Adaptive Function to_time<string>

Parameters
xfunction execute parameter.

Converts string value to time.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function to_time<string>(
value: string
): time;

Parameters:

value - (string)

Returns:

(time)

Errors thrown:

cast_error - value could not be converted

Implemented by afw_function_execute_convert()


Function definition to_x500Name<string>

Definition at line 28760 of file afw_function_bindings.h.

◆ afw_function_definition_to_yearMonthDuration_string

afw_function_definition_to_yearMonthDuration_string

Adaptive Function to_x500Name<string>

Parameters
xfunction execute parameter.

Converts string value to x500Name.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function to_x500Name<string>(
value: string
): x500Name;

Parameters:

value - (string)

Returns:

(x500Name)

Errors thrown:

cast_error - value could not be converted

Implemented by afw_function_execute_convert()


Function definition to_yearMonthDuration<string>

Definition at line 28798 of file afw_function_bindings.h.

◆ afw_function_definition_union_string

afw_function_definition_union_string

Adaptive Function to_yearMonthDuration<string>

Parameters
xfunction execute parameter.

Converts string value to yearMonthDuration.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function to_yearMonthDuration<string>(
value: string
): yearMonthDuration;

Parameters:

value - (string)

Returns:

(yearMonthDuration)

Errors thrown:

cast_error - value could not be converted

Implemented by afw_function_execute_convert()


Function definition union<string>

Definition at line 28836 of file afw_function_bindings.h.

◆ afw_function_definition_url_decode

afw_function_definition_url_decode

Adaptive Function union<string>

Parameters
xfunction execute parameter.

Returns a list of string contains all of the unique values in two or more list of string values.

This function is pure, so it will always return the same result given exactly the same parameters and has no side effects.

Declaration:

function union<string>(
lists_1: (list string),
lists_2: (list string),
...lists_rest: (list of (list string))
): (list string);

Parameters:

lists - (2 or more list string) Two or more lists.

Returns:

(list string)

Implemented by afw_function_execute_union()


Function definition url_decode

Definition at line 28873 of file afw_function_bindings.h.