Functions: F¶

28 functions (42 overloads) on BasicRuntime.Functions starting with F.

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

FADD¶

1 overload

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

Performs the fadd operation using the supplied value1, value2.


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

How this member is tested

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

FCORRELATIVE¶

1 overload

static DynamicArray Functions.FCORRELATIVE(DynamicArray value)

Performs the fcorrelative operation using the supplied value.


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

How this member is tested

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

FIELD¶

3 overloads · BASIC reference

Overload 1

static DynamicArray Functions.FIELD(DynamicArray value, DynamicArray seperator, DynamicArray fieldPos)

Performs the field operation using the supplied value, seperator, fieldPos.


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

How this member is tested

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

Overload 2

static DynamicArray Functions.FIELD(DynamicArray value, DynamicArray seperator, int fieldPos)

Performs the field operation using the supplied value, seperator, fieldPos.


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

How this member is tested

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

static DynamicArray Functions.FIELD(DynamicArray value, DynamicArray seperator, int fieldPos, int occurances)

Performs the field operation using the supplied value, seperator, fieldPos, occurances.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.FIELD(...) directly (no instance required) when your code needs to perform the field operation using the supplied value, seperator, fieldPos, occurances.

How this member is tested

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

FIELDS¶

2 overloads

Overload 1

static DynamicArray Functions.FIELDS(DynamicArray value, DynamicArray seperator, DynamicArray occurance)

Performs the fields operation using the supplied value, seperator, occurance.


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

How this member is tested

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

Overload 2

static DynamicArray Functions.FIELDS(DynamicArray value, string seperator, int occurance, int noSubStr)

Performs the fields operation using the supplied value, seperator, occurance, noSubStr.


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

How this member is tested

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

FIELDSTORE¶

1 overload

static DynamicArray Functions.FIELDSTORE(DynamicArray value, DynamicArray seperator, int startPosition, int noToReplace, DynamicArray replaceValue)

Performs the fieldstore operation using the supplied value, seperator, startPosition, noToReplace, replaceValue.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.FIELDSTORE(...) directly (no instance required) when your code needs to perform the fieldstore operation using the supplied value, seperator, startPosition, noToReplace, replaceValue.

How this member is tested

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

FILEINFO¶

1 overload

static DynamicArray Functions.FILEINFO(DynamicArray fileVariable, DynamicArray infoType)

Performs the fileinfo operation using the supplied fileVariable, infoType.


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

How this member is tested

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

FILELOCK¶

2 overloads

Overload 1

static bool Functions.FILELOCK(DynamicArray fileVariable, bool waitForLock)

Performs the filelock operation using the supplied fileVariable, waitForLock.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.FILELOCK(...) directly (no instance required) when your code needs to perform the filelock operation using the supplied fileVariable, waitForLock.

How this member is tested

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

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

Overload 2

static bool Functions.FILELOCK(DynamicArray fileVariable, string lockType, bool waitForLock)

Performs the filelock operation using the supplied fileVariable, lockType, waitForLock.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.FILELOCK(...) directly (no instance required) when your code needs to perform the filelock operation using the supplied fileVariable, lockType, waitForLock.

How this member is tested

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

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

FILEPATH¶

1 overload

static DynamicArray Functions.FILEPATH(DynamicArray fileVariable)

Performs the filepath operation using the supplied fileVariable.


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

How this member is tested

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

FILEUNLOCK¶

1 overload

static void Functions.FILEUNLOCK(DynamicArray fileVariable)

Performs the fileunlock operation using the supplied fileVariable.


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

How this member is tested

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

FILE_APPEND¶

1 overload

static bool Functions.FILE_APPEND(DynamicArray sourceFile, DynamicArray destinationFile)

Performs the file_append operation using the supplied sourceFile, destinationFile.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.FILE_APPEND(...) directly (no instance required) when your code needs to perform the file_append operation using the supplied sourceFile, destinationFile.

How this member is tested

Act: var result = Functions.FILE_APPEND(/* 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 file_append check for the given input.

FILE_COPY¶

1 overload

static bool Functions.FILE_COPY(DynamicArray sourceFile, DynamicArray destinationFile)

Performs the file_copy operation using the supplied sourceFile, destinationFile.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.FILE_COPY(...) directly (no instance required) when your code needs to perform the file_copy operation using the supplied sourceFile, destinationFile.

How this member is tested

Act: var result = Functions.FILE_COPY(/* 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 file_copy check for the given input.

FILE_DELETE¶

2 overloads

Overload 1

static bool Functions.FILE_DELETE(DynamicArray sourceFile, DynamicArray blankParm)

Performs the file_delete operation using the supplied sourceFile, blankParm.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.FILE_DELETE(...) directly (no instance required) when your code needs to perform the file_delete operation using the supplied sourceFile, blankParm.

How this member is tested

Act: var result = Functions.FILE_DELETE(/* 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 file_delete check for the given input.

Overload 2

static bool Functions.FILE_DELETE(DynamicArray sourceFile)

Performs the file_delete operation using the supplied sourceFile.


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

How this member is tested

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

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

FILE_EXISTS¶

1 overload

static bool Functions.FILE_EXISTS(DynamicArray sourceFile)

Performs the file_exists operation using the supplied sourceFile.


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

How this member is tested

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

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

FILE_MOVE¶

1 overload

static bool Functions.FILE_MOVE(DynamicArray sourceFile, DynamicArray destinationFile)

Performs the file_move operation using the supplied sourceFile, destinationFile.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.FILE_MOVE(...) directly (no instance required) when your code needs to perform the file_move operation using the supplied sourceFile, destinationFile.

How this member is tested

Act: var result = Functions.FILE_MOVE(/* 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 file_move check for the given input.

FIND¶

3 overloads

Overload 1

static bool Functions.FIND(DynamicArray value, DynamicArray subString, int occurence, DynamicArray attribute, DynamicArray multivalue, DynamicArray subvalue)

Performs the find operation using the supplied value, subString, occurence, attribute, multivalue, subvalue.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.FIND(...) directly (no instance required) when your code needs to perform the find operation using the supplied value, subString, occurence, attribute, multivalue, subvalue.

How this member is tested

Act: var result = Functions.FIND(/* a valid DynamicArray value */, /* a valid DynamicArray value */, 1, /* a valid DynamicArray value */, /* 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 find check for the given input.

Overload 2

static bool Functions.FIND(DynamicArray value, DynamicArray subString, int occurence, DynamicArray attribute, DynamicArray multivalue)

Performs the find operation using the supplied value, subString, occurence, attribute, multivalue.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.FIND(...) directly (no instance required) when your code needs to perform the find operation using the supplied value, subString, occurence, attribute, multivalue.

How this member is tested

Act: var result = Functions.FIND(/* a valid DynamicArray value */, /* a valid DynamicArray value */, 1, /* 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 find check for the given input.

Overload 3

static bool Functions.FIND(DynamicArray value, DynamicArray subString, int occurence, DynamicArray attribute)

Performs the find operation using the supplied value, subString, occurence, attribute.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.FIND(...) directly (no instance required) when your code needs to perform the find operation using the supplied value, subString, occurence, attribute.

How this member is tested

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

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

findAccountPath¶

1 overload

static string Functions.findAccountPath(string accountName)

Performs the find account path operation using the supplied accountName.


Kind	Method (static)
Returns	`string`
Use case	Call Functions.findAccountPath(...) directly (no instance required) when your code needs to perform the find account path operation using the supplied accountName.

How this member is tested

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

FINDSTR¶

3 overloads

Overload 1

static bool Functions.FINDSTR(DynamicArray value, DynamicArray subString, int occurence, DynamicArray attribute, DynamicArray multivalue, DynamicArray subvalue)

Performs the findstr operation using the supplied value, subString, occurence, attribute, multivalue, subvalue.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.FINDSTR(...) directly (no instance required) when your code needs to perform the findstr operation using the supplied value, subString, occurence, attribute, multivalue, subvalue.

How this member is tested

Act: var result = Functions.FINDSTR(/* a valid DynamicArray value */, /* a valid DynamicArray value */, 1, /* a valid DynamicArray value */, /* 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 findstr check for the given input.

Overload 2

static bool Functions.FINDSTR(DynamicArray value, DynamicArray subString, int occurence, DynamicArray attribute, DynamicArray multivalue)

Performs the findstr operation using the supplied value, subString, occurence, attribute, multivalue.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.FINDSTR(...) directly (no instance required) when your code needs to perform the findstr operation using the supplied value, subString, occurence, attribute, multivalue.

How this member is tested

Act: var result = Functions.FINDSTR(/* a valid DynamicArray value */, /* a valid DynamicArray value */, 1, /* 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 findstr check for the given input.

Overload 3

static bool Functions.FINDSTR(DynamicArray value, DynamicArray subString, int occurence, DynamicArray attribute)

Performs the findstr operation using the supplied value, subString, occurence, attribute.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.FINDSTR(...) directly (no instance required) when your code needs to perform the findstr operation using the supplied value, subString, occurence, attribute.

How this member is tested

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

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

FIX¶

3 overloads

Overload 1

static DynamicArray Functions.FIX(DynamicArray value)

Performs the fix operation using the supplied value.


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

How this member is tested

Act: var result = Functions.FIX(/* 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.FIX(DynamicArray value, double prescision)

Performs the fix operation using the supplied value, prescision.


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

How this member is tested

Act: var result = Functions.FIX(/* a valid DynamicArray value */, 1.0)
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.FIX(DynamicArray value, double prescision, int type)

Performs the fix operation using the supplied value, prescision, type.


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

How this member is tested

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

FLUSH¶

2 overloads

Overload 1

static void Functions.FLUSH()

Performs the flush operation.


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

How this member is tested

Act: Functions.FLUSH()
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

static DynamicArray Functions.FLUSH(DynamicArray fileVariable)

Performs the flush operation using the supplied fileVariable.


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

How this member is tested

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

FMT¶

1 overload

static DynamicArray Functions.FMT(DynamicArray value, DynamicArray expression)

Performs the fmt operation using the supplied value, expression.


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

How this member is tested

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

FMTS¶

1 overload

static DynamicArray Functions.FMTS(DynamicArray value, string expression)

Performs the fmts operation using the supplied value, expression.


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

How this member is tested

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

FOLD¶

2 overloads

Overload 1

static DynamicArray Functions.FOLD(string value, int width)

Performs the fold operation using the supplied value, width.


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

How this member is tested

Act: var result = Functions.FOLD("sample", 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.FOLD(string value, int width, string separator)

Performs the fold operation using the supplied value, width, separator.


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

How this member is tested

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

FOLDER¶

1 overload

static bool Functions.FOLDER(string path)

Performs the folder operation using the supplied path.


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

How this member is tested

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

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

FOOTING¶

1 overload

static void Functions.FOOTING(string footing, int channelNo)

Performs the footing operation using the supplied footing, channelNo.


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

How this member is tested

Act: Functions.FOOTING("sample", 1)
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).

FORMLIST¶

2 overloads · BASIC reference

Overload 1

static void Functions.FORMLIST(DynamicArray value, int listNumber)

Performs the formlist operation using the supplied value, listNumber.


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

How this member is tested

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

static void Functions.FORMLIST(DynamicArray value, DynamicArray listVariable)

Performs the formlist operation using the supplied value, listVariable.


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

How this member is tested

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

FTP_DOWNLOAD¶

1 overload

static bool Functions.FTP_DOWNLOAD(DynamicArray hostName, DynamicArray userName, DynamicArray password, DynamicArray port, DynamicArray directory, DynamicArray sourceFile, DynamicArray destinationFile, DynamicArray deleteRemote)

Performs the ftp_download operation using the supplied hostName, userName, password, port, directory, sourceFile, destinationFile, deleteRemote.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.FTP_DOWNLOAD(...) directly (no instance required) when your code needs to perform the ftp_download operation using the supplied hostName, userName, password, port, directory, sourceFile, destinationFile, deleteRemote.

How this member is tested

Act: var result = Functions.FTP_DOWNLOAD(/* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* 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 ftp_download check for the given input.

FTP_UPLOAD¶

1 overload

static bool Functions.FTP_UPLOAD(DynamicArray hostName, DynamicArray userName, DynamicArray password, DynamicArray port, DynamicArray directory, DynamicArray sourceFile, DynamicArray destinationFile, DynamicArray deleteLocal)

Performs the ftp_upload operation using the supplied hostName, userName, password, port, directory, sourceFile, destinationFile, deleteLocal.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.FTP_UPLOAD(...) directly (no instance required) when your code needs to perform the ftp_upload operation using the supplied hostName, userName, password, port, directory, sourceFile, destinationFile, deleteLocal.

How this member is tested

Act: var result = Functions.FTP_UPLOAD(/* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* 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 ftp_upload check for the given input.

FUNCTION¶

1 overload

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

Performs the function operation using the supplied subName, args.


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

How this member is tested

Act: var result = Functions.FUNCTION("sample", /* 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.