Functions: P¶

30 functions (35 overloads) on BasicRuntime.Functions starting with P.

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

PAGE¶

1 overload

static void Functions.PAGE(DynamicArray channel, DynamicArray pageNumber)

Performs the page operation using the supplied channel, pageNumber.


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

How this member is tested

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

PARSEBASIC¶

2 overloads

Overload 1

static int Functions.PARSEBASIC(DynamicArray basicCode)

Performs the parsebasic operation using the supplied basicCode.


Kind	Method (static)
Returns	`int`
Use case	Call Functions.PARSEBASIC(...) directly (no instance required) when your code needs to perform the parsebasic operation using the supplied basicCode.

How this member is tested

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

Overload 2

static int Functions.PARSEBASIC(DynamicArray basicCode, DynamicArray additionalFunctions)

Performs the parsebasic operation using the supplied basicCode, additionalFunctions.


Kind	Method (static)
Returns	`int`
Use case	Call Functions.PARSEBASIC(...) directly (no instance required) when your code needs to perform the parsebasic operation using the supplied basicCode, additionalFunctions.

How this member is tested

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

parseEscapeCodes¶

1 overload

static string Functions.parseEscapeCodes(string literal)

Performs the parse escape codes operation using the supplied literal.


Kind	Method (static)
Returns	`string`
Use case	Call Functions.parseEscapeCodes(...) directly (no instance required) when your code needs to perform the parse escape codes operation using the supplied literal.

How this member is tested

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

PARSESTRING¶

1 overload

static DynamicArray Functions.PARSESTRING(string value)

Performs the parsestring operation using the supplied value.


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

How this member is tested

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

PASSWD¶

1 overload

static DynamicArray Functions.PASSWD(string userName, string oldPassword, string newPassword)

Performs the passwd operation using the supplied userName, oldPassword, newPassword.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.PASSWD(...) directly (no instance required) when your code needs to perform the passwd operation using the supplied userName, oldPassword, newPassword.

How this member is tested

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

PATTERNMATCH¶

1 overload

static bool Functions.PATTERNMATCH(DynamicArray value, DynamicArray patternMatch)

Performs the patternmatch operation using the supplied value, patternMatch.


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

How this member is tested

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

PCPERFORM¶

1 overload

static DynamicArray Functions.PCPERFORM(string dosCmd, DynamicArray capturing)

Performs the pcperform operation using the supplied dosCmd, capturing.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.PCPERFORM(...) directly (no instance required) when your code needs to perform the pcperform operation using the supplied dosCmd, capturing.

How this member is tested

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

PDFADDIMAGE¶

1 overload

static bool Functions.PDFADDIMAGE(string pdfFilePath, string pdfSavePath, string imageFilePath, int x, int y, DynamicArray allPages)

Performs the pdfaddimage operation using the supplied pdfFilePath, pdfSavePath, imageFilePath, x, y, allPages.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.PDFADDIMAGE(...) directly (no instance required) when your code needs to perform the pdfaddimage operation using the supplied pdfFilePath, pdfSavePath, imageFilePath, x, y, allPages.

How this member is tested

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

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

PDFOVERLAY¶

1 overload

static bool Functions.PDFOVERLAY(string pdfFilePath, string overlayFilePath, string pdfSavePath)

Performs the pdfoverlay operation using the supplied pdfFilePath, overlayFilePath, pdfSavePath.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.PDFOVERLAY(...) directly (no instance required) when your code needs to perform the pdfoverlay operation using the supplied pdfFilePath, overlayFilePath, pdfSavePath.

How this member is tested

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

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

PDFPROTECT¶

1 overload

static DynamicArray Functions.PDFPROTECT(string pdfFilePath, string pdfSavePath, string userPassword, string ownerPassword, DynamicArray allowCopy, DynamicArray allowPrinting)

Performs the pdfprotect operation using the supplied pdfFilePath, pdfSavePath, userPassword, ownerPassword, allowCopy, allowPrinting.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.PDFPROTECT(...) directly (no instance required) when your code needs to perform the pdfprotect operation using the supplied pdfFilePath, pdfSavePath, userPassword, ownerPassword, allowCopy, allowPrinting.

How this member is tested

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

PEEKNEXT¶

1 overload

static bool Functions.PEEKNEXT(DynamicArray returnVar, int listNumber)

Performs the peeknext operation using the supplied returnVar, listNumber.


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

How this member is tested

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

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

PERFORM¶

1 overload

static void Functions.PERFORM(DynamicArray command, ref DynamicArray capturing, DynamicArray passList, ref DynamicArray rtnList, ref DynamicArray setting)

Performs the perform operation using the supplied command, capturing, passList, rtnList, setting.


Kind	Method (static)
Returns	`void`
Use case	Call Functions.PERFORM(...) directly (no instance required) when your code needs to perform the perform operation using the supplied command, capturing, passList, rtnList, setting.

How this member is tested

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

PRECACHE¶

1 overload

static DynamicArray Functions.PRECACHE(DynamicArray fileVariable)

Performs the precache operation using the supplied fileVariable.


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

How this member is tested

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

PRECISION¶

1 overload

static void Functions.PRECISION(DynamicArray value)

Performs the precision operation using the supplied value.


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

How this member is tested

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

PRINT¶

2 overloads · BASIC reference

Overload 1

static void Functions.PRINT(string value, bool suppressCrlf)

Performs the print operation using the supplied value, suppressCrlf.


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

How this member is tested

Act: Functions.PRINT("sample", true)
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.PRINT(string value, bool suppressCrlf, int channel)

Performs the print operation using the supplied value, suppressCrlf, channel.


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

How this member is tested

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

PRINTER¶

1 overload

static void Functions.PRINTER(bool mode)

Performs the printer operation using the supplied mode.


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

How this member is tested

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

PRINTERCLOSE¶

2 overloads · BASIC reference

Overload 1

static void Functions.PRINTERCLOSE()

Performs the printerclose operation.


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

How this member is tested

Act: Functions.PRINTERCLOSE()
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.PRINTERCLOSE(int channel)

Performs the printerclose operation using the supplied channel.


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

How this member is tested

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

PRINTERR¶

2 overloads

Overload 1

static bool Functions.PRINTERR(DynamicArray msgParams)

Performs the printerr operation using the supplied msgParams.


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

How this member is tested

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

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

Overload 2

static bool Functions.PRINTERR(DynamicArray msgParams, DynamicArray msgFile)

Performs the printerr operation using the supplied msgParams, msgFile.


Kind	Method (static)
Returns	`bool`
Use case	Call Functions.PRINTERR(...) directly (no instance required) when your code needs to perform the printerr operation using the supplied msgParams, msgFile.

How this member is tested

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

PRINTERRESET¶

1 overload

static void Functions.PRINTERRESET()

Performs the printerreset operation.


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

How this member is tested

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

PROCESS¶

1 overload

static DynamicArray Functions.PROCESS(int pid)

Performs the process operation using the supplied pid.


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

How this member is tested

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

processFmtString¶

1 overload

static string Functions.processFmtString(string value, FormatMask mask, bool usingReporter)

Performs the process fmt string operation using the supplied value, mask, usingReporter.


Kind	Method (static)
Returns	`string`
Use case	Call Functions.processFmtString(...) directly (no instance required) when your code needs to perform the process fmt string operation using the supplied value, mask, usingReporter.

How this member is tested

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

processReuse¶

1 overload

static void Functions.processReuse(ref DynamicArray array1, ref DynamicArray array2)

Performs the process reuse operation using the supplied array1, array2.


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

How this member is tested

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

PROCESS_CONFIG¶

1 overload

static void Functions.PROCESS_CONFIG(DynamicArray configVar)

Performs the process_config operation using the supplied configVar.


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

How this member is tested

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

PROCREAD¶

1 overload

static bool Functions.PROCREAD(DynamicArray value)

Performs the procread operation using the supplied value.


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

How this member is tested

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

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

PROCWRITE¶

1 overload

static void Functions.PROCWRITE(DynamicArray value)

Performs the procwrite operation using the supplied value.


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

How this member is tested

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

PROMPT¶

1 overload

static void Functions.PROMPT(DynamicArray value)

Performs the prompt operation using the supplied value.


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

How this member is tested

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

PROTOCOLLOGGING¶

1 overload

static DynamicArray Functions.PROTOCOLLOGGING(string filePath, string action, int level)

Performs the protocollogging operation using the supplied filePath, action, level.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.PROTOCOLLOGGING(...) directly (no instance required) when your code needs to perform the protocollogging operation using the supplied filePath, action, level.

How this member is tested

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

PSCAN¶

1 overload

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

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


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

How this member is tested

Act: var result = Functions.PSCAN(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 pscan check for the given input.

PURGE_QUEUE¶

2 overloads

Overload 1

static DynamicArray Functions.PURGE_QUEUE(string queueName)

Performs the purge_queue operation using the supplied queueName.


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

How this member is tested

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

Overload 2

static DynamicArray Functions.PURGE_QUEUE(string machineName, string queueName)

Performs the purge_queue operation using the supplied machineName, queueName.


Kind	Method (static)
Returns	`DynamicArray`
Use case	Call Functions.PURGE_QUEUE(...) directly (no instance required) when your code needs to perform the purge_queue operation using the supplied machineName, queueName.

How this member is tested

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

PWR¶

1 overload

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

Performs the pwr operation using the supplied value1, value2.


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

How this member is tested

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