Functions: U¶
15 functions (16 overloads) on BasicRuntime.Functions starting with U.
UDOARRAYAPPENDITEM¶
Performs the udoarrayappenditem operation using the supplied udoHandle, value.
| Kind | Method (static) |
| Returns | int |
| Use case | Call Functions.UDOARRAYAPPENDITEM(...) directly (no instance required) when your code needs to perform the udoarrayappenditem operation using the supplied udoHandle, value. |
How this member is tested
Act: var result = Functions.UDOARRAYAPPENDITEM(/* a valid DynamicArray value */, /* a valid object value */)
Assert: result equals the expected computed value.
Expected: Returns a int value; verify it equals the expected computed result for the given input.
UDOARRAYGETITEM¶
static int Functions.UDOARRAYGETITEM(DynamicArray udoHandle, DynamicArray index, DynamicArray value, DynamicArray type)
Performs the udoarraygetitem operation using the supplied udoHandle, index, value, type.
| Kind | Method (static) |
| Returns | int |
| Use case | Call Functions.UDOARRAYGETITEM(...) directly (no instance required) when your code needs to perform the udoarraygetitem operation using the supplied udoHandle, index, value, type. |
How this member is tested
Act: var result = Functions.UDOARRAYGETITEM(/* 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.
UDOARRAYGETNEXTITEM¶
static int Functions.UDOARRAYGETNEXTITEM(DynamicArray udoHandle, DynamicArray value, DynamicArray type)
Performs the udoarraygetnextitem operation using the supplied udoHandle, value, type.
| Kind | Method (static) |
| Returns | int |
| Use case | Call Functions.UDOARRAYGETNEXTITEM(...) directly (no instance required) when your code needs to perform the udoarraygetnextitem operation using the supplied udoHandle, value, type. |
How this member is tested
Act: var result = Functions.UDOARRAYGETNEXTITEM(/* 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.
UDOARRAYGETSIZE¶
Performs the udoarraygetsize operation using the supplied udoHandle, size.
| Kind | Method (static) |
| Returns | int |
| Use case | Call Functions.UDOARRAYGETSIZE(...) directly (no instance required) when your code needs to perform the udoarraygetsize operation using the supplied udoHandle, size. |
How this member is tested
Act: var result = Functions.UDOARRAYGETSIZE(/* 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.
UDOCREATE¶
Performs the udocreate operation using the supplied udoType, udoHandle.
| Kind | Method (static) |
| Returns | int |
| Use case | Call Functions.UDOCREATE(...) directly (no instance required) when your code needs to perform the udocreate operation using the supplied udoType, udoHandle. |
How this member is tested
Act: var result = Functions.UDOCREATE(/* 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.
UDOFREE¶
Performs the udofree operation using the supplied udoHandle.
| Kind | Method (static) |
| Returns | int |
| Use case | Call Functions.UDOFREE(...) directly (no instance required) when your code needs to perform the udofree operation using the supplied udoHandle. |
How this member is tested
Act: var result = Functions.UDOFREE(/* 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.
UDOGETLASTERROR¶
Performs the udogetlasterror operation using the supplied errorCode, errorMessage.
| Kind | Method (static) |
| Returns | int |
| Use case | Call Functions.UDOGETLASTERROR(...) directly (no instance required) when your code needs to perform the udogetlasterror operation using the supplied errorCode, errorMessage. |
How this member is tested
Act: var result = Functions.UDOGETLASTERROR(/* 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.
UDOGETPROPERTY¶
static int Functions.UDOGETPROPERTY(DynamicArray udoHandle, DynamicArray name, DynamicArray value, DynamicArray type)
Performs the udogetproperty operation using the supplied udoHandle, name, value, type.
| Kind | Method (static) |
| Returns | int |
| Use case | Call Functions.UDOGETPROPERTY(...) directly (no instance required) when your code needs to perform the udogetproperty operation using the supplied udoHandle, name, value, type. |
How this member is tested
Act: var result = Functions.UDOGETPROPERTY(/* 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.
UDOREAD¶
static int Functions.UDOREAD(DynamicArray inputString, DynamicArray inputType, DynamicArray udoHandle)
Performs the udoread operation using the supplied inputString, inputType, udoHandle.
| Kind | Method (static) |
| Returns | int |
| Use case | Call Functions.UDOREAD(...) directly (no instance required) when your code needs to perform the udoread operation using the supplied inputString, inputType, udoHandle. |
How this member is tested
Act: var result = Functions.UDOREAD(/* 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.
UDOSETOPTION¶
Performs the udosetoption operation using the supplied option, value.
| Kind | Method (static) |
| Returns | int |
| Use case | Call Functions.UDOSETOPTION(...) directly (no instance required) when your code needs to perform the udosetoption operation using the supplied option, value. |
How this member is tested
Act: var result = Functions.UDOSETOPTION(/* a valid DynamicArray value */, /* a valid object value */)
Assert: result equals the expected computed value.
Expected: Returns a int value; verify it equals the expected computed result for the given input.
UDOSETPROPERTY¶
static int Functions.UDOSETPROPERTY(DynamicArray udoHandle, string name, object value, int dataType)
Performs the udosetproperty operation using the supplied udoHandle, name, value, dataType.
| Kind | Method (static) |
| Returns | int |
| Use case | Call Functions.UDOSETPROPERTY(...) directly (no instance required) when your code needs to perform the udosetproperty operation using the supplied udoHandle, name, value, dataType. |
How this member is tested
Act: var result = Functions.UDOSETPROPERTY(/* a valid DynamicArray value */, "sample", /* a valid object value */, 1)
Assert: result equals the expected computed value.
Expected: Returns a int value; verify it equals the expected computed result for the given input.
UDOWRITE¶
static int Functions.UDOWRITE(DynamicArray udoHandle, DynamicArray outputType, DynamicArray outputString)
Performs the udowrite operation using the supplied udoHandle, outputType, outputString.
| Kind | Method (static) |
| Returns | int |
| Use case | Call Functions.UDOWRITE(...) directly (no instance required) when your code needs to perform the udowrite operation using the supplied udoHandle, outputType, outputString. |
How this member is tested
Act: var result = Functions.UDOWRITE(/* 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.
UNASSIGNED¶
Performs the unassigned operation using the supplied value.
| Kind | Method (static) |
| Returns | DynamicArray |
| Use case | Call Functions.UNASSIGNED(...) directly (no instance required) when your code needs to perform the unassigned operation using the supplied value. |
How this member is tested
Act: var result = Functions.UNASSIGNED(/* 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.
UNLOCK¶
Overload 1
Performs the unlock operation.
| Kind | Method (static) |
| Returns | void |
| Use case | Call Functions.UNLOCK(...) directly (no instance required) when your code needs to perform the unlock operation. |
How this member is tested
Act: Functions.UNLOCK()
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).
Overload 2
Performs the unlock operation using the supplied lockNumber.
| Kind | Method (static) |
| Returns | void |
| Use case | Call Functions.UNLOCK(...) directly (no instance required) when your code needs to perform the unlock operation using the supplied lockNumber. |
How this member is tested
Act: Functions.UNLOCK(/* 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).
UPCASE¶
Performs the upcase operation using the supplied value.
| Kind | Method (static) |
| Returns | DynamicArray |
| Use case | Call Functions.UPCASE(...) directly (no instance required) when your code needs to perform the upcase operation using the supplied value. |
How this member is tested
Act: var result = Functions.UPCASE("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.