Functions: B¶

9 functions (11 overloads) on BasicRuntime.Functions starting with B.

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

BASE64DECODE¶

static DynamicArray Functions.BASE64DECODE(DynamicArray value)

Performs the base64decode operation using the supplied value.


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

How this member is tested

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

BASE64ENCODE¶

1 overload · BASIC reference

static DynamicArray Functions.BASE64ENCODE(DynamicArray value)

Performs the base64encode operation using the supplied value.


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

How this member is tested

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

BATCHEND¶

1 overload · BASIC reference

static DynamicArray Functions.BATCHEND(DynamicArray fileVariable)

Performs the batchend operation using the supplied fileVariable.


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

How this member is tested

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

BATCHSTART¶

2 overloads · BASIC reference

Overload 1

static DynamicArray Functions.BATCHSTART(DynamicArray fileVariable)

Performs the batchstart operation using the supplied fileVariable.


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

How this member is tested

Act: var result = Functions.BATCHSTART(/* 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.BATCHSTART(DynamicArray fileVariable, DynamicArray batchSize)

Performs the batchstart operation using the supplied fileVariable, batchSize.


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

How this member is tested

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

BEGINTRANSACTION¶

1 overload · BASIC reference

static bool Functions.BEGINTRANSACTION()

Performs the begintransaction operation.


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

How this member is tested

Act: var result = Functions.BEGINTRANSACTION()
Assert: result matches the expected true/false outcome.

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

BITXOR¶

1 overload

static DynamicArray Functions.BITXOR(DynamicArray value1, DynamicArray value2)

Performs the bitxor operation using the supplied value1, value2.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.BITXOR(...) directly (no instance required) when your code needs to perform the bitxor operation using the supplied value1, value2.

How this member is tested

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

BREAK¶

1 overload

static void Functions.BREAK(DynamicArray value)

Performs the break operation using the supplied value.


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

How this member is tested

Act: Functions.BREAK(/* 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).

BSCAN¶

2 overloads

Overload 1

static bool Functions.BSCAN(ref DynamicArray recordId, DynamicArray fileVariable, string startPosition, string indexName, bool reset, bool clear, string byOrder)

Performs the bscan operation using the supplied recordId, fileVariable, startPosition, indexName, reset, clear, byOrder.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.BSCAN(...) directly (no instance required) when your code needs to perform the bscan operation using the supplied recordId, fileVariable, startPosition, indexName, reset, clear, byOrder.

How this member is tested

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

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

Overload 2

static bool Functions.BSCAN(ref DynamicArray recordId, ref DynamicArray record, DynamicArray fileVariable, string startPosition, string indexName, bool reset, bool clear, string byOrder)

Performs the bscan operation using the supplied recordId, record, fileVariable, startPosition, indexName, reset, clear, byOrder.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.BSCAN(...) directly (no instance required) when your code needs to perform the bscan operation using the supplied recordId, record, fileVariable, startPosition, indexName, reset, clear, byOrder.

How this member is tested

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

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

buildLockInfo¶

1 overload

static string Functions.buildLockInfo(string cmd, DynamicArray fileVariable, string key)

Performs the build lock info operation using the supplied cmd, fileVariable, key.


Kind	Method (static)
Returns	`string`
Use case	Call Functions.buildLockInfo(...) directly (no instance required) when your code needs to perform the build lock info operation using the supplied cmd, fileVariable, key.

How this member is tested

Act: var result = Functions.buildLockInfo("sample", /* a valid DynamicArray value */, "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.