Functions: I¶

20 functions (31 overloads) on BasicRuntime.Functions starting with I.

A B C D E F G H I K L M N O P Q R S T U W X Z

ICONV¶

static DynamicArray Functions.ICONV(DynamicArray value, DynamicArray conversion)

Performs the iconv operation using the supplied value, conversion.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.ICONV(...) directly (no instance required) when your code needs to perform the iconv operation using the supplied value, conversion.

How this member is tested

Act: var result = Functions.ICONV(/* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

ICONVS¶

1 overload

static DynamicArray Functions.ICONVS(string value, string conversion)

Performs the iconvs operation using the supplied value, conversion.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.ICONVS(...) directly (no instance required) when your code needs to perform the iconvs operation using the supplied value, conversion.

How this member is tested

Act: var result = Functions.ICONVS("sample", "sample")
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

IFS¶

1 overload

static DynamicArray Functions.IFS(DynamicArray array1, DynamicArray trueArray, DynamicArray falseArray)

Performs the ifs operation using the supplied array1, trueArray, falseArray.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.IFS(...) directly (no instance required) when your code needs to perform the ifs operation using the supplied array1, trueArray, falseArray.

How this member is tested

Act: var result = Functions.IFS(/* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

IN¶

2 overloads

Overload 1

static bool Functions.IN(DynamicArray value, DynamicArray timeOut)

Performs the in operation using the supplied value, timeOut.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.IN(...) directly (no instance required) when your code needs to perform the in operation using the supplied value, timeOut.

How this member is tested

Act: var result = Functions.IN(/* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result matches the expected true/false outcome.

Expected: Returns true or false, indicating the outcome of the in check for the given input.

Overload 2

static DynamicArray Functions.IN()

Performs the in operation.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.IN(...) directly (no instance required) when your code needs to perform the in operation.

How this member is tested

Act: var result = Functions.IN()
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

INDEX¶

2 overloads · BASIC reference

Overload 1

static DynamicArray Functions.INDEX(DynamicArray value, DynamicArray subString)

Performs the index operation using the supplied value, subString.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.INDEX(...) directly (no instance required) when your code needs to perform the index operation using the supplied value, subString.

How this member is tested

Act: var result = Functions.INDEX(/* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

Overload 2

static DynamicArray Functions.INDEX(DynamicArray value, DynamicArray subString, DynamicArray occurance)

Performs the index operation using the supplied value, subString, occurance.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.INDEX(...) directly (no instance required) when your code needs to perform the index operation using the supplied value, subString, occurance.

How this member is tested

Act: var result = Functions.INDEX(/* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

INDEXS¶

1 overload

static DynamicArray Functions.INDEXS(DynamicArray value, DynamicArray subString, DynamicArray occurance)

Performs the indexs operation using the supplied value, subString, occurance.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.INDEXS(...) directly (no instance required) when your code needs to perform the indexs operation using the supplied value, subString, occurance.

How this member is tested

Act: var result = Functions.INDEXS(/* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

INDICES¶

2 overloads

Overload 1

static DynamicArray Functions.INDICES(DynamicArray fileVariable, DynamicArray indexName)

Performs the indices operation using the supplied fileVariable, indexName.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.INDICES(...) directly (no instance required) when your code needs to perform the indices operation using the supplied fileVariable, indexName.

How this member is tested

Act: var result = Functions.INDICES(/* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

Overload 2

static DynamicArray Functions.INDICES(DynamicArray fileVariable)

Performs the indices operation using the supplied fileVariable.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.INDICES(...) directly (no instance required) when your code needs to perform the indices operation using the supplied fileVariable.

How this member is tested

Act: var result = Functions.INDICES(/* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

INITIALISE¶

1 overload

static void Functions.INITIALISE(dynamic program)

Performs the initialise operation using the supplied program.


Kind	Method (static)
Returns	`void`
Use case	Call Functions.INITIALISE(...) directly (no instance required) when your code needs to perform the initialise operation using the supplied program.

How this member is tested

Act: Functions.INITIALISE(/* a valid dynamic value */)
Assert: no exception is thrown and the expected side effect occurred.

Expected: No return value; verify the intended side effect occurred (state change, event raised, or exception NOT thrown for valid input).

INITSERVERSOCKET¶

1 overload

static DynamicArray Functions.INITSERVERSOCKET(string ipAddress, int port, int backLog, DynamicArray socket)

Performs the initserversocket operation using the supplied ipAddress, port, backLog, socket.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.INITSERVERSOCKET(...) directly (no instance required) when your code needs to perform the initserversocket operation using the supplied ipAddress, port, backLog, socket.

How this member is tested

Act: var result = Functions.INITSERVERSOCKET("sample", 1, 1, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

INLIST¶

1 overload

static bool Functions.INLIST(string value, string list)

Performs the inlist operation using the supplied value, list.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.INLIST(...) directly (no instance required) when your code needs to perform the inlist operation using the supplied value, list.

How this member is tested

Act: var result = Functions.INLIST("sample", "sample")
Assert: result matches the expected true/false outcome.

Expected: Returns true or false, indicating the outcome of the inlist check for the given input.

INMAT¶

2 overloads

Overload 1

static DynamicArray Functions.INMAT()

Performs the inmat operation.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.INMAT(...) directly (no instance required) when your code needs to perform the inmat operation.

How this member is tested

Act: var result = Functions.INMAT()
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

Overload 2

static DynamicArray Functions.INMAT(DimensionedArray array)

Performs the inmat operation using the supplied array.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.INMAT(...) directly (no instance required) when your code needs to perform the inmat operation using the supplied array.

How this member is tested

Act: var result = Functions.INMAT(/* a valid DimensionedArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

INPUT¶

5 overloads

Overload 1

static DynamicArray Functions.INPUT(DynamicArray prompt, DynamicArray length, bool suppressCrLf, bool waitForCr, DynamicArray xpos, DynamicArray ypos)

Performs the input operation using the supplied prompt, length, suppressCrLf, waitForCr, xpos, ypos.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.INPUT(...) directly (no instance required) when your code needs to perform the input operation using the supplied prompt, length, suppressCrLf, waitForCr, xpos, ypos.

How this member is tested

Act: var result = Functions.INPUT(/* a valid DynamicArray value */, /* a valid DynamicArray value */, true, true, /* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

Overload 2

static DynamicArray Functions.INPUT(DynamicArray prompt, DynamicArray length, bool suppressCrLf, bool waitForCr, DynamicArray xpos, DynamicArray ypos, string mask)

Performs the input operation using the supplied prompt, length, suppressCrLf, waitForCr, xpos, ypos, mask.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.INPUT(...) directly (no instance required) when your code needs to perform the input operation using the supplied prompt, length, suppressCrLf, waitForCr, xpos, ypos, mask.

How this member is tested

Act: var result = Functions.INPUT(/* a valid DynamicArray value */, /* a valid DynamicArray value */, true, true, /* a valid DynamicArray value */, /* a valid DynamicArray value */, "sample")
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

Overload 3

static DynamicArray Functions.INPUT(DynamicArray prompt, DynamicArray length, bool suppressCrLf, bool waitForCr, string mask)

Performs the input operation using the supplied prompt, length, suppressCrLf, waitForCr, mask.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.INPUT(...) directly (no instance required) when your code needs to perform the input operation using the supplied prompt, length, suppressCrLf, waitForCr, mask.

How this member is tested

Act: var result = Functions.INPUT(/* a valid DynamicArray value */, /* a valid DynamicArray value */, true, true, "sample")
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

Overload 4

static bool Functions.INPUT(DynamicArray prompt, DynamicArray length, bool suppressCrLf, bool waitForCr, int timeOut, ref DynamicArray ans)

Performs the input operation using the supplied prompt, length, suppressCrLf, waitForCr, timeOut, ans.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.INPUT(...) directly (no instance required) when your code needs to perform the input operation using the supplied prompt, length, suppressCrLf, waitForCr, timeOut, ans.

How this member is tested

Act: var result = Functions.INPUT(/* a valid DynamicArray value */, /* a valid DynamicArray value */, true, true, 1, ref /* a valid DynamicArray value */)
Assert: result matches the expected true/false outcome.

Expected: Returns true or false, indicating the outcome of the input check for the given input.

Overload 5

static DynamicArray Functions.INPUT(DynamicArray Prompt, DynamicArray length, bool suppressCrLf, bool waitForCr)

Performs the input operation using the supplied Prompt, length, suppressCrLf, waitForCr.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.INPUT(...) directly (no instance required) when your code needs to perform the input operation using the supplied Prompt, length, suppressCrLf, waitForCr.

How this member is tested

Act: var result = Functions.INPUT(/* a valid DynamicArray value */, /* a valid DynamicArray value */, true, true)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

INPUTCLEAR¶

1 overload

static void Functions.INPUTCLEAR()

Performs the inputclear operation.


Kind	Method (static)
Returns	`void`
Use case	Call Functions.INPUTCLEAR(...) directly (no instance required) when your code needs to perform the inputclear operation.

How this member is tested

Act: Functions.INPUTCLEAR()
Assert: no exception is thrown and the expected side effect occurred.

Expected: No return value; verify the intended side effect occurred (state change, event raised, or exception NOT thrown for valid input).

INPUTERR¶

1 overload

static void Functions.INPUTERR(DynamicArray msg, bool supressCr)

Performs the inputerr operation using the supplied msg, supressCr.


Kind	Method (static)
Returns	`void`
Use case	Call Functions.INPUTERR(...) directly (no instance required) when your code needs to perform the inputerr operation using the supplied msg, supressCr.

How this member is tested

Act: Functions.INPUTERR(/* a valid DynamicArray value */, true)
Assert: no exception is thrown and the expected side effect occurred.

Expected: No return value; verify the intended side effect occurred (state change, event raised, or exception NOT thrown for valid input).

INSERT¶

3 overloads

Overload 1

static DynamicArray Functions.INSERT(DynamicArray value, int attribute, DynamicArray expression)

Performs the insert operation using the supplied value, attribute, expression.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.INSERT(...) directly (no instance required) when your code needs to perform the insert operation using the supplied value, attribute, expression.

How this member is tested

Act: var result = Functions.INSERT(/* a valid DynamicArray value */, 1, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

Overload 2

static DynamicArray Functions.INSERT(DynamicArray value, int attribute, int multivalue, DynamicArray expression)

Performs the insert operation using the supplied value, attribute, multivalue, expression.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.INSERT(...) directly (no instance required) when your code needs to perform the insert operation using the supplied value, attribute, multivalue, expression.

How this member is tested

Act: var result = Functions.INSERT(/* a valid DynamicArray value */, 1, 1, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

Overload 3

static DynamicArray Functions.INSERT(DynamicArray value, int attribute, int multivalue, int subvalue, DynamicArray expression)

Performs the insert operation using the supplied value, attribute, multivalue, subvalue, expression.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.INSERT(...) directly (no instance required) when your code needs to perform the insert operation using the supplied value, attribute, multivalue, subvalue, expression.

How this member is tested

Act: var result = Functions.INSERT(/* a valid DynamicArray value */, 1, 1, 1, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

INT¶

1 overload · BASIC reference

static decimal Functions.INT(DynamicArray value)

Performs the int operation using the supplied value.


Kind	Method (static)
Returns	`decimal`
Use case	Call Functions.INT(...) directly (no instance required) when your code needs to perform the int operation using the supplied value.

How this member is tested

Act: var result = Functions.INT(/* a valid DynamicArray value */)
Assert: result equals the expected computed value.

Expected: Returns a decimal value; verify it equals the expected computed result for the given input.

ISINDEX¶

2 overloads

Overload 1

static DynamicArray Functions.ISINDEX(DynamicArray fileVariable)

Performs the isindex operation using the supplied fileVariable.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.ISINDEX(...) directly (no instance required) when your code needs to perform the isindex operation using the supplied fileVariable.

How this member is tested

Act: var result = Functions.ISINDEX(/* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

Overload 2

static DynamicArray Functions.ISINDEX(DynamicArray fileVariable, string fieldName)

Performs the isindex operation using the supplied fileVariable, fieldName.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.ISINDEX(...) directly (no instance required) when your code needs to perform the isindex operation using the supplied fileVariable, fieldName.

How this member is tested

Act: var result = Functions.ISINDEX(/* a valid DynamicArray value */, "sample")
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

ISNULL¶

1 overload

static DynamicArray Functions.ISNULL(DynamicArray value)

Performs the isnull operation using the supplied value.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.ISNULL(...) directly (no instance required) when your code needs to perform the isnull operation using the supplied value.

How this member is tested

Act: var result = Functions.ISNULL(/* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.

Iterate¶

1 overload

static void Functions.Iterate(dynamic variable)

Performs the iterate operation using the supplied variable.


Kind	Method (static)
Returns	`void`
Use case	Call Functions.Iterate(...) directly (no instance required) when your code needs to perform the iterate operation using the supplied variable.

How this member is tested

Act: Functions.Iterate(/* a valid dynamic value */)
Assert: no exception is thrown and the expected side effect occurred.

Expected: No return value; verify the intended side effect occurred (state change, event raised, or exception NOT thrown for valid input).

ITYPE¶

1 overload

static DynamicArray Functions.ITYPE(DynamicArray itype)

Performs the itype operation using the supplied itype.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.ITYPE(...) directly (no instance required) when your code needs to perform the itype operation using the supplied itype.

How this member is tested

Act: var result = Functions.ITYPE(/* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.

Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.