Functions: G¶

21 functions (24 overloads) on BasicRuntime.Functions starting with G.

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

GCI¶

1 overload

static DynamicArray Functions.GCI(string subName, ref object[] args)

Performs the gci operation using the supplied subName, args.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.GCI(...) directly (no instance required) when your code needs to perform the gci operation using the supplied subName, args.

How this member is tested

Act: var result = Functions.GCI("sample", ref /* a populated collection */)
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.

GES¶

1 overload

static DynamicArray Functions.GES(DynamicArray array1, DynamicArray array2)

Performs the ges operation using the supplied array1, array2.


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

How this member is tested

Act: var result = Functions.GES(/* 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.

GET¶

1 overload

static bool Functions.GET(DynamicArray argNo, ref DynamicArray variable)

Performs the get operation using the supplied argNo, variable.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.GET(...) directly (no instance required) when your code needs to perform the get operation using the supplied argNo, variable.

How this member is tested

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

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

GETCWD¶

1 overload

static bool Functions.GETCWD(ref DynamicArray value)

Performs the getcwd operation using the supplied value.


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

How this member is tested

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

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

GETENV¶

1 overload

static DynamicArray Functions.GETENV(string variableName)

Performs the getenv operation using the supplied variableName.


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

How this member is tested

Act: var result = Functions.GETENV("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.

GETFIELDVALUE¶

2 overloads

Overload 1

static string Functions.GETFIELDVALUE(DynamicArray dictName, DynamicArray dictRec, DynamicArray dictFileVar)

Performs the getfieldvalue operation using the supplied dictName, dictRec, dictFileVar.


Kind	Method (static)
Returns	`string`
Use case	Call Functions.GETFIELDVALUE(...) directly (no instance required) when your code needs to perform the getfieldvalue operation using the supplied dictName, dictRec, dictFileVar.

How this member is tested

Act: var result = Functions.GETFIELDVALUE(/* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result is non-null and matches the expected text.

Expected: Returns a string value; verify it is non-null and matches the expected content.

Overload 2

static string Functions.GETFIELDVALUE(DynamicArray dictName, DynamicArray dictRec)

Performs the getfieldvalue operation using the supplied dictName, dictRec.


Kind	Method (static)
Returns	`string`
Use case	Call Functions.GETFIELDVALUE(...) directly (no instance required) when your code needs to perform the getfieldvalue operation using the supplied dictName, dictRec.

How this member is tested

Act: var result = Functions.GETFIELDVALUE(/* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result is non-null and matches the expected text.

Expected: Returns a string value; verify it is non-null and matches the expected content.

getFieldValue¶

1 overload

static string Functions.getFieldValue(DictionaryRecord dictRec)

Performs the get field value operation using the supplied dictRec.


Kind	Method (static)
Returns	`string`
Use case	Call Functions.getFieldValue(...) directly (no instance required) when your code needs to perform the get field value operation using the supplied dictRec.

How this member is tested

Act: var result = Functions.getFieldValue(/* a valid DictionaryRecord value */)
Assert: result is non-null and matches the expected text.

Expected: Returns a string value; verify it is non-null and matches the expected content.

GETLIST¶

2 overloads

Overload 1

static bool Functions.GETLIST(string listName, int listNumber)

Performs the getlist operation using the supplied listName, listNumber.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.GETLIST(...) directly (no instance required) when your code needs to perform the getlist operation using the supplied listName, listNumber.

How this member is tested

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

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

Overload 2

static bool Functions.GETLIST(string listName, int listNumber, DynamicArray settingVar)

Performs the getlist operation using the supplied listName, listNumber, settingVar.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.GETLIST(...) directly (no instance required) when your code needs to perform the getlist operation using the supplied listName, listNumber, settingVar.

How this member is tested

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

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

getNextSpoolId¶

1 overload

static string Functions.getNextSpoolId(string startName)

Performs the get next spool id operation using the supplied startName.


Kind	Method (static)
Returns	`string`
Use case	Call Functions.getNextSpoolId(...) directly (no instance required) when your code needs to perform the get next spool id operation using the supplied startName.

How this member is tested

Act: var result = Functions.getNextSpoolId("sample")
Assert: result is non-null and matches the expected text.

Expected: Returns a string value; verify it is non-null and matches the expected content.

getObjectFromCache¶

1 overload

static subroutineObject Functions.getObjectFromCache(string subName)

Performs the get object from cache operation using the supplied subName.


Kind	Method (static)
Returns	`subroutineObject`
Use case	Call Functions.getObjectFromCache(...) directly (no instance required) when your code needs to perform the get object from cache operation using the supplied subName.

How this member is tested

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

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

getOconvCall¶

1 overload

static string Functions.getOconvCall(string value, string convCode)

Performs the get oconv call operation using the supplied value, convCode.


Kind	Method (static)
Returns	`string`
Use case	Call Functions.getOconvCall(...) directly (no instance required) when your code needs to perform the get oconv call operation using the supplied value, convCode.

How this member is tested

Act: var result = Functions.getOconvCall("sample", "sample")
Assert: result is non-null and matches the expected text.

Expected: Returns a string value; verify it is non-null and matches the expected content.

getOconvPackedDecimal¶

1 overload

static string Functions.getOconvPackedDecimal(string value)

Performs the get oconv packed decimal operation using the supplied value.


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

How this member is tested

Act: var result = Functions.getOconvPackedDecimal("sample")
Assert: result is non-null and matches the expected text.

Expected: Returns a string value; verify it is non-null and matches the expected content.

GETPU¶

1 overload

static DynamicArray Functions.GETPU(DynamicArray unitNo)

Performs the getpu operation using the supplied unitNo.


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

How this member is tested

Act: var result = Functions.GETPU(/* 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.

getRawFieldValue¶

1 overload

static string Functions.getRawFieldValue(DictionaryRecord dictRec)

Performs the get raw field value operation using the supplied dictRec.


Kind	Method (static)
Returns	`string`
Use case	Call Functions.getRawFieldValue(...) directly (no instance required) when your code needs to perform the get raw field value operation using the supplied dictRec.

How this member is tested

Act: var result = Functions.getRawFieldValue(/* a valid DictionaryRecord value */)
Assert: result is non-null and matches the expected text.

Expected: Returns a string value; verify it is non-null and matches the expected content.

GETREADU¶

1 overload

static DynamicArray Functions.GETREADU()

Performs the getreadu operation.


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

How this member is tested

Act: var result = Functions.GETREADU()
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.

getRegex¶

1 overload

static string Functions.getRegex(string patternMatch)

Performs the get regex operation using the supplied patternMatch.


Kind	Method (static)
Returns	`string`
Use case	Call Functions.getRegex(...) directly (no instance required) when your code needs to perform the get regex operation using the supplied patternMatch.

How this member is tested

Act: var result = Functions.getRegex("sample")
Assert: result is non-null and matches the expected text.

Expected: Returns a string value; verify it is non-null and matches the expected content.

GETUSERNAME¶

2 overloads

Overload 1

static DynamicArray Functions.GETUSERNAME(int pid)

Performs the getusername operation using the supplied pid.


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

How this member is tested

Act: var result = Functions.GETUSERNAME(1)
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.GETUSERNAME(DynamicArray pid)

Performs the getusername operation using the supplied pid.


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

How this member is tested

Act: var result = Functions.GETUSERNAME(/* 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.

GETXMLERROR¶

1 overload

static void Functions.GETXMLERROR(DynamicArray errorCode, DynamicArray errorMessage)

Performs the getxmlerror operation using the supplied errorCode, errorMessage.


Kind	Method (static)
Returns	`void`
Use case	Call Functions.GETXMLERROR(...) directly (no instance required) when your code needs to perform the getxmlerror operation using the supplied errorCode, errorMessage.

How this member is tested

Act: Functions.GETXMLERROR(/* a valid DynamicArray value */, /* a valid DynamicArray 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).

GROUP¶

1 overload

static DynamicArray Functions.GROUP(string value, string seperator, int start, int noOccurs)

Performs the group operation using the supplied value, seperator, start, noOccurs.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.GROUP(...) directly (no instance required) when your code needs to perform the group operation using the supplied value, seperator, start, noOccurs.

How this member is tested

Act: var result = Functions.GROUP("sample", "sample", 1, 1)
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.

GTS¶

1 overload

static DynamicArray Functions.GTS(DynamicArray array1, DynamicArray array2)

Performs the gts operation using the supplied array1, array2.


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

How this member is tested

Act: var result = Functions.GTS(/* 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.

GUID¶

1 overload

static DynamicArray Functions.GUID()

Performs the guid operation.


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

How this member is tested

Act: var result = Functions.GUID()
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.