Nest

Call (start) a nested macro. This command is included for DOS compatibility. The Windows equivalent is Run.

A nested macro starts immediately when called. When a nested macro ends, the first statement following Nest is executed.

PerfectScript automatically compiles uncompiled Nest macros. Macro execution stops if the macro will not compile.

NetAddConnection

NetCancelConnection

Terminate a connection to a network resource.

NetConnectionDlg

NetDisconnectDlg

NetGetConnection

NetGetUniversalName

NetGetUser

NewDefault

Specify a macro's new default application. NewDefault accepts the prefix of an OLE object, as well as a product mnemonic.

The compiler verifies that each product command is valid for the default application. Invalid product commands produce a syntax error during compilation. This is a compile-time only statement, and makes the specified object prefix or product mnemonic the current default prefix for unknown commands.

Product commands to the default application do not require a product prefix. A product command to a non-default application, without a product prefix, creates a compile-time syntax error.

Next

Advance a loop iteration before the end of the loop.

Use Next inside a conditional statement such as If or Switch in a loop to advance a loop iteration when a specified condition is met. Statements after Next are ignored.

NOT

Operator. Precedence level 1. Invert the result of a relational expression. See Logical Operators and Logical Expressions

NotFound

Determine how a macro responds to a Not Found condition.

A Not Found condition is generally the result of a failed search. Create a Not Found condition with Assert(NotFoundCondition!).

NthRoot

NToC

NToC

NumStr

A character string of numbers.

vText := NumStr(999; 0) // vText = "999"
vText := NumStr(3+7; 0) // vText = "10"

Object

Defines an OLE object variable prefix.

After a prefix variable is defined, the prefix is used to identify all object method (command) calls and properties (values). Before methods and properties can be accessed, an object instance must be assigned to this variable by the CreateObject or GetObject commands.

ObjectInfo

OemString

OnCancel

Specify a Label or routine (function or procedure) to execute when a Cancel condition occurs.

A macro with more than one OnCancel executes the last OnCancel before a Cancel condition occurs. A Cancel condition stops a macro unless preceded by OnCancel.

OnCancel Call

Specify a Label-Return statement or routine (function or procedure) to execute when a Cancel condition occurs.

Return directs macro execution to the first statement after the Cancel condition.

A macro with more than one OnCancel Call executes the last OnCancel Call before a Cancel condition occurs. A Cancel condition stops a macro unless preceded by OnCancel Call.

OnCondition

Specify a Label or routine (function or procedure) to execute when a Cancel, Error, NotFound, or user-defined condition occurs.

A macro with more than one OnCondition executes the last Condition command before a Cancel, Error, NotFound, or user-defined condition occurs. One of these conditions stops a macro unless preceded by OnCondition.

OnCondition Call

Specify a Label-Return statement or routine (function or procedure) to execute when a specified condition occurs. See Condition.

Return directs macro execution to the first statement after the specified condition.

A macro with more than one OnCondition Call executes the last Condition command before a Cancel, Error, NotFound, or user-defined condition occurs. One of these conditions stops a macro unless preceded by OnCondition Call.

The previous Label set to execute by the OnCancel Call command. If there is no label, "" is returned.

OnDDEAdvise Call

Refer to a Microsoft SDK (DdeGetLastError function) for detailed information on each enumeration.

One of the following enumerations:

OnError

Specify a Label or routine (function or procedure) to execute when an Error condition occurs.

A macro with more than one OnError statement executes the last OnError before an Error condition occurs. An Error condition stops a macro unless preceded by OnError.

OnError Call

Specify a Label-Return statement or routine (function or procedure) to execute when an Error condition occurs.

Return directs macro execution to the first statement after the Error condition.

A macro with more than one OnError Call statement executes the last OnError Call before an Error condition occurs. An Error condition stops a macro unless preceded by OnError Call.

OnExit

Specifies a label or routine (function or procedure) to execute when an Exit condition occurs.

A macro calls this label when it encounters one of the following exit conditions: Quit command, Return command from the main body of a macro, all macro statements have been executed (macro ends), Exitcondition! asserted (see Assert command).

OnNotFound

Specify a Label or routine (function or procedure) to execute when a Not Found condition occurs.

A macro with more than one OnNotFound statement executes the last OnNotFound before a Not Found condition occurs. A Not Found condition stops a macro unless preceded by OnNotFound.

OnNotFound Call

Specify a Label-Return statement or routine (function or procedure) to call when a Not Found condition occurs.

Return directs macro execution to the first statement after the Not Found condition.

A macro with more than one OnNotFound Call statement calls the last OnNotFound Call before a Not Found condition occurs. A Not Found condition stops a macro unless preceded by OnNotFound Call.

OpenFile

Open a file for reading and writing text data.

Close the file when it is no longer needed, or system resources will be lost. The file is closed automatically when the macro ends. See CloseFile.

The file ID, or a negative number if an error occurs. The following file I/O (input/output) commands require a file ID:

• CloseFile
• FileIsEOF
• FilePosition
• FileRead
• FileTruncate
• FileWrite

OR

Pause

Pause a macro, returning computer control to the user.

To resume macro execution, press Enter, or choose Tools, Macro, Pause. To stop a macro, choose Tools, Macro, Play. When Pause follows a Prompt statement, choose OK to resume macro execution or Cancel to create a Cancel condition.

Persist

Declare PerfectFit variables and arrays, and assign them to the persistent variable table.

Persist variables are available to any PerfectFit application while PerfectFit is running.

PersistAll

Assign a macro's variables and arrays to the Persist variable table.

Persist variables are available to any PerfectFit application while PerfectFit is running.

Only variables assigned values after PersistAll or declared Persist are Persist variables. Variables assigned values before PersistAll, and variables declared Local or Global, are not Persist variables. In the following example, only var6 and var7 are Persist variables:

Application(A1; "WordPerfect"; Default; "US")

Local var1; var2

var3 = 0

Global var4

Persist var7

var7 = "Persist Variable"

PersistAll

Local var5

var4 = 2

var6 = "Persist Variable"

pi

Procedure

Identify a macro subroutine that can receive one or more values from a calling statement (see Calling Statements in Chapter 5: Conditional, Loop, and Calling Statements).

Procedures contain one or more statements that execute when the procedure is called. Unlike Label subroutines, procedures do not execute unless called. A calling statement consists of the procedure's name, and can have one or more parameters that contain values passed to the procedure. Return, EndProc, or EndProcedure direct macro execution to the statement that follows the procedure's caller.

Address Mode

To change the value of a variable passed to a procedure, precede the calling statement parameter and its corresponding procedure parameter with an ampersand (&). In the following example, the value of x is 5 after calling Test:

x := 5
Test(x) // calling statement

Procedure Test(z)
 z := z + 5
EndProc

In the next example, the value of x is 10 after calling Test:

x := 5
Test(&x) // calling statement

Procedure Test(&z)
 z := z + 5
EndProc

The ampersand before variable x means the variable's address (location in memory) is passed to the procedure, not the variable's value. Changes made at the address of x are made to the contents of x.

The general form of a Procedure statement is:

Procedure <Name> (<Parameter>; <Parameter>)
 ...statement block...
EndProc

The syntax accepts EndProc or EndProcedure.

Procedure Prototype

Verify the syntax of a Procedure statement (see Procedure).

If the syntax of a procedure contained in a Use macro file is incorrect and the procedure is called from the main macro, you get a run-time error but not a compile-time error (see Compiler Errors in Chapter 3: Creating Macros). Use Procedure Prototype at the start of a main macro so that syntax errors will appear as compile-time errors instead of run-time errors.

Product

Prompt

Display a message box with OK and Cancel button controls.

Pause following Prompt displays a Prompt message box until the user selects OK or Cancel. OK removes the prompt and resumes macro execution. Cancel removes the prompt and creates a Cancel condition (see OnCancel).

If Prompt is not followed by Pause, the message box is displayed until an EndPrompt occurs or the macro ends. You can display only one message box at a time. Calling a second message box replaces the first.

The general form of a Prompt statement is:

Prompt (Title; Prompt; Style; HorizontalPosition; VerticalPosition)
Pause

A Prompt statement can have another form:

Prompt (Title; Prompt; Style; HorizontalPosition; VerticalPosition)
 ...other statements...
EndPrompt

Quit