Functions: W¶

8 functions (9 overloads) on BasicRuntime.Functions starting with W.

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

WEOFSEQ¶

1 overload

static void Functions.WEOFSEQ(DynamicArray fileVariable)

Performs the weofseq operation using the supplied fileVariable.


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

How this member is tested

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

WRITE¶

1 overload · BASIC reference

static bool Functions.WRITE(DynamicArray fileVariable, DynamicArray key, DynamicArray record, DynamicArray attribute, bool lockRecord, bool throwLockedException, bool throwErrorException)

Performs the write operation using the supplied fileVariable, key, record, attribute, lockRecord, throwLockedException, throwErrorException.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.WRITE(...) directly (no instance required) when your code needs to perform the write operation using the supplied fileVariable, key, record, attribute, lockRecord, throwLockedException, throwErrorException.

How this member is tested

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

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

WRITEBLK¶

1 overload

static bool Functions.WRITEBLK(DynamicArray fileVariable, DynamicArray record, bool throwErrorException, bool flush)

Performs the writeblk operation using the supplied fileVariable, record, throwErrorException, flush.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.WRITEBLK(...) directly (no instance required) when your code needs to perform the writeblk operation using the supplied fileVariable, record, throwErrorException, flush.

How this member is tested

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

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

WRITELIST¶

1 overload

static void Functions.WRITELIST(DynamicArray listVariable, string listName)

Performs the writelist operation using the supplied listVariable, listName.


Kind	Method (static)
Returns	`void`
Use case	Call Functions.WRITELIST(...) directly (no instance required) when your code needs to perform the writelist operation using the supplied listVariable, listName.

How this member is tested

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

WRITESEQ¶

1 overload

static bool Functions.WRITESEQ(DynamicArray fileVariable, DynamicArray record, bool throwErrorException, bool flush)

Performs the writeseq operation using the supplied fileVariable, record, throwErrorException, flush.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.WRITESEQ(...) directly (no instance required) when your code needs to perform the writeseq operation using the supplied fileVariable, record, throwErrorException, flush.

How this member is tested

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

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

WRITESOCKET¶

1 overload

static int Functions.WRITESOCKET(DynamicArray socket, DynamicArray socketData, DynamicArray timeOut, DynamicArray blockingMode, DynamicArray actualWriteSize)

Performs the writesocket operation using the supplied socket, socketData, timeOut, blockingMode, actualWriteSize.


Kind	Method (static)
Returns	`int`
Use case	Call Functions.WRITESOCKET(...) directly (no instance required) when your code needs to perform the writesocket operation using the supplied socket, socketData, timeOut, blockingMode, actualWriteSize.

How this member is tested

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

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

WRITE_QUEUE¶

2 overloads

Overload 1

static int Functions.WRITE_QUEUE(DynamicArray mq, string socketData)

Performs the write_queue operation using the supplied mq, socketData.


Kind	Method (static)
Returns	`int`
Use case	Call Functions.WRITE_QUEUE(...) directly (no instance required) when your code needs to perform the write_queue operation using the supplied mq, socketData.

How this member is tested

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

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

Overload 2

static int Functions.WRITE_QUEUE(DynamicArray mq, string message, string messageId)

Performs the write_queue operation using the supplied mq, message, messageId.


Kind	Method (static)
Returns	`int`
Use case	Call Functions.WRITE_QUEUE(...) directly (no instance required) when your code needs to perform the write_queue operation using the supplied mq, message, messageId.

How this member is tested

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

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

WRITE_SOCKET¶

1 overload

static int Functions.WRITE_SOCKET(DynamicArray socket, DynamicArray socketData, int flags, int timeOut)

Performs the write_socket operation using the supplied socket, socketData, flags, timeOut.


Kind	Method (static)
Returns	`int`
Use case	Call Functions.WRITE_SOCKET(...) directly (no instance required) when your code needs to perform the write_socket operation using the supplied socket, socketData, flags, timeOut.

How this member is tested

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

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