SiMX Help‎ > ‎The Target Platform‎ > ‎Objects‎ > ‎DS (Data Source)‎ > ‎

Format


Common Objects


Description

Creates a string of values separated by the provided delimiter.

Syntax

Function Format( values, [names], [delim] )

Parameters:

array values - values (strings or numerics)
array names  - names  (optional).
string delim - delimiter to use (optional, default = ",")

Note: if the names parameter is present, then the number of items in values and names arrays has to be the same.

Return Values:

string - the result string

Example

Dim string1, string2
string1 = DS.Format( Array( "value1", "value2", 3 ) )
string2 = DS.Format( Array( "value1", "value2", 3 ), Array( "v1", "v2", "v3" ), ";" )

When the names parameter present, the result string2  value is:

v1='value1';v2='value2';v3=3

Without the names parameter the result string1 value is:

'value1','value2',3

Note: a value of type string is additionally embraced into single quote characters.

See also