Verbs and Built-in Functions

&AOMALERT

Generates or simulates an AOM event, WTO, VM MSG, or MVS DOM, and routes it as required.

AS

V

&AOMCONT

Releases a message from an AOMPROC for delivery, passes the message to another AOMPROC for processing, or sends a copy of the current message to an ISR connected system.

AS

V

&AOMDEL

Deletes the message that an AOMPROC is processing.

AS

V

&AOMFLAG

Alters the value of an AOM global flag.

AS

V

&AOMFLAG

Inspects the value of an AOM global flag.

AS

B

&AOMGVAR

Alters the value of an AOM global variable.

AS

V

&AOMGVAR

Inspects the value of an AOM global variable.

AS

B

&AOMINIT

Indicates to regard the current procedure as an AOMPROC, and registers the procedure for message delivery.

AS

V

&AOMMIGID

Determines whether a migration ID is required.

AS

B

&AOMMINLN

Accesses the text of a specific minor line of a multiline WTO message in an AOMPROC.

AS

B

&AOMMINLT

Accesses the line type of a specific minor line of a multiline WTO message in an AOMPROC.

AS

B

&AOMREAD

Requests to make the next message available to an AOMPROC.

AS

V

&AOMREPL

Alters the text of a message and release the message for local delivery.

AS

V

&APPC

Provides access to LU6.2 conversations.

V

&APPSTAT

Returns the status for a VTAM application.

B

&ASISTR

Assigns a multiword string into a variable, retaining leading blanks.

B

&ASSIGN

Updates lists of variables in one operation.

V

&BOOLEXPR

Evaluates a Boolean expression.

B

&CALL procedure

Invokes an NCL procedure.

V

&CALL program

Invokes a user program.

V

&CMDLINE

Writes text into your OCS command input line.

V

&CNMALERT

Sends a CNM record directly to CNMPROC in a local or remote NEWS system for processing.

SNA

V

&CNMCLEAR

Requests to clear all outstanding CNM reply data solicited by this NCL user.

SNA

V

&CNMCONT

Directs the current CNM record across a specific ISR link.

SNA

V

&CNMDEL

Deletes a CNM record or stops ISR delivery of the record to a remote region.

SNA

V

&CNMPARSE

Requests to parse the MDO data supplied into user variables.

SNA

V

&CNMREAD

Requests to make the next CNM record available to an NCL procedure.

SNA

V

&CNMSEND

Requests to send the data supplied across the CNM interface.

SNA

V

&CNMVECTR

Requests to vector the data supplied into user variables.

SNA

V

&CONCAT

Concatenates multiple variables/constants.

B

&CONTROL

Sets NCL procedure control characteristics.

V

&DATECONV

Changes a date format.

B

&DEC

Converts a hexadecimal number to its decimal equivalent.

B

&DECODE

Decodes part or all of an MDO.

V

&DELAY

Interrupts processing of a procedure for a specified period of time.

V

&DO

Groups a sequence of NCL statements to form a logical program function.

V

&DOEND

Signifies the logical end of a group of statements.

V

&DOM

Issues an MVS DOM to erase a non-roll delete (NRD) WTO.

V

&DOUNTIL

Builds a conditional loop with a test at the bottom.

V

&DOWHILE

Builds a conditional loop with a test at the top.

V

&ELSE

Specifies that the code following is the alternative path after &IF, where the &IF condition is false.

V

&ENCODE

Encodes all or part of an MDO.

V

&END

Terminates the current nesting level.

V

&ENDAFTER

Terminates the current nesting level after executing the command following the &ENDAFTER.

V

&EVENT

Signals an event occurrence.

V

&EXIT

Terminates the current nesting level.

V

&FILE

Connects, disconnects, switches, accesses, modifies, and deletes file records.

V

&FLUSH

Terminates all nesting levels within an NCL process.

V

&FNDSTR

Determines whether a string occurs within one or more variables.

V

&GOSUB

Branches to a subroutine within the procedure.

V

&GOTO

Branches to another statement within the procedure.

V

&HEX

Converts a decimal number to its hexadecimal equivalent.

B

&HEXEXP

Converts a character string to its hexadecimal equivalent.

B

&HEXPACK

Converts a hexadecimal string into equivalent characters.

V

&IF

Tests the truth of a logical expression.

V

&INTCLEAR

Clears messages queued to a dependent processing environment.

V

&INTCMD

Schedules a command to execute in the dependent environment of the issuing process.

V

&INTCONT

Propagates a message to the next higher processing environment.

V

&INTREAD

Retrieves the next message queued from the dependent processing environment of the issuing process.

V

&INTREPL

Propagates a message to the next higher processing environment, and changes the message text.

V

&INVSTR

Inverts a string.

B

&LBLSTR

Removes leading blanks from a string.

B

&LENGTH

Tells you the length of a variable or constant.

B

&LOCK

Obtains or releases access to a resource.

V

&LOGCONT

Resumes normal processing of a message delivered to LOGPROC.

V

&LOGDEL

Deletes a log record that LOGPROC is processing.

V

&LOGON

Passes control of a terminal to another application.

V

&LOGREAD

Makes the next log message available to LOGPROC.

V

&LOGREPL

Replaces the text of the last log message delivered to LOGPROC.

V

&LOOPCTL

Sets a new runaway loop control limit.

V

&MAICMD

Specifies an MAI primary command.

SNAACCESS

V

&MAICONT

Sends the current data stream on to the terminal and/or the application.

SNAACCESS

V

&MAICURSA

Sets up the cursor address to send to the application.

SNAACCESS

V

&MAIDEL

Signifies not to deliver a data stream.

SNAACCESS

V

&MAIDSFMT

Places the entire current data stream into variables.

SNAACCESS

V

&MAIFIND

Determines whether a data stream contains a given string.

SNAACCESS

V

&MAIINKEY

Sets the attention key that is to be simulated in a data stream.

SNAACCESS

V

&MAIPUT

Builds a data stream to send to the PLU (application).

SNAACCESS

V

&MAIREAD

Waits for the next data stream.

SNAACCESS

V

&MAIREPL

Replaces a data stream destined for the terminal.

SNAACCESS

V

&MAISADD

Adds a new session definition, based on user variables.

SNAACCESS

V

&MAISCMD

Specifies an MAI session command against the current session.

SNAACCESS

V

&MAISGET

Retrieves details of the specified session into user variables.

SNAACCESS

V

&MAISPUT

Updates MAI session list entries.

SNAACCESS

V

&MASKCHK

Tests a data string against a wildcard mask.

B

&MSGCONT

Resumes normal processing of a message delivered to MSGPROC.

V

&MSGDEL

Deletes a message that MSGPROC is processing.

V

&MSGREAD

Makes the next message available to MSGPROC.

V

&MSGREPL

Replaces the text of a message delivered to MSGPROC.

V

&NBLSTR

Removes leading and trailing blanks from a string.

B

&NDBADD

Adds a record to an NDB database.

V

&NDBCLOSE

Signs off (disconnects) from an NDB database.

V

&NDBCTL

Alters NDB processing characteristics.

V

&NDBDEF

Adds, updates, or deletes field definitions.

V

&NDBDEL

Deletes a record from an NDB database.

V

&NDBFMT

Defines a list of fields for an &NDBGET to retrieve.

V

&NDBGET

Retrieves a record from an NDB database.

V

&NDBINFO

Retrieves information about an NDB database.

V

&NDBOPEN

Signs on (connects) to an NDB database.

V

&NDBPHON

Allows you to return a phonetic value for a character string, typically a name.

V

&NDBQUOTE

Places quotes around data to protect special characters.

B

&NDBSCAN

Scans an NDB database for all records matching a search argument.

V

&NDBSEQ

Defines, deletes, or resets a sequential retrieval path for an NDB database.

V

&NDBUPD

Updates a record in an NDB database.

V

&NPFxCHK

Tests a user's network partitioning authority for a resource.

B

&NRDDEL

Deletes NRD messages.

V

&NUMEDIT

Edits the format of a real number or integer.

B

&OVERLAY

Replaces a section of a data string with data from another string.

B

&PANEL

Displays a full-screen panel.

V

&PANELEND

Gives up exclusive control of a display window.

V

&PARSE

Parses tokenized strings into variables.

V

&PAUSE

Suspends an NCL process.

V

&PPI

Allows exchange of data between programs.

V

&PPOALERT

Generates a simulated VTAM PPO message.

V

&PPOCONT

Resumes normal processing of a VTAM PPO message.

V

&PPODEL

Deletes a VTAM PPO message, or blocks its delivery.

V

&PPOREAD

Makes the next VTAM PPO message available to PPOPROC.

V

&PPOREPL

Resumes normal VTAM PPO message processing, after replacing message text.

V

&PROMPT

Writes text to a user's terminal and awaits input.

V

&QEXITR

Terminates this procedure, plus all higher levels.

V

&REMSTR

Splits a data string and returns the end portion.

B

&RETCODE

Returns or resets the system return code.

V

&RETSUB

Returns from a subroutine within a procedure.

V

&RETURN

Passes variables to a higher nesting level.

V

&RSCCHECK

Tests the access of a user to a resource.

B

&SECCALL

Communicates with the security subsystem or the installation security exit.

V

&SELSTR

Splits a data string and returns the front portion.

B

&SETBLNK

Explicitly sets a variable to blank.

B

&SETLENG

Sets the length of a variable.

B

&SETVARS

Extracts named keywords and associated data from a data string.

V

&SMFWRITE

(z/OS only) Writes a record to the SMF data set.

V

&SNAMS

Provides the client/server interface to invoke object-oriented services.

SNA

V

&SOCKET

Provides NCL control over allocation and management of communications using TCP/IP.

V

&STR

Assigns a multiword string.

B

&SUBSTR

Extracts part of a variable or constant.

B

&TBLSTR

Removes trailing blanks from a string.

B

&TRANS

Translates characters within a string.

B

&TYPECHK

Tests variables and returns their type.

B

&VARTABLE

Creates and maintains vartables and vartable entries.

V

&WRITE

Writes a message.

V

&WTO

Issues a WTO.

V

&WTOR

Issues a WTOR and waits for a reply.

V

&ZAMCHECK

Indicates whether support is enabled for a specified access method.

B

&ZFEATURE

Returns availability status of a feature.

B

&ZNCLKWD

Indicates whether the string is an NCL keyword.

B

&ZOSCHK

Indicates whether support is enabled for a specified operating system.

B

&ZPSKIP

Sets new active panel skip data.

V

&ZQUOTE and &ZQUOTE2

Places quotes around a string.

B

&ZSHRINK

Removes leading and trailing spaces and reduces multiple spaces within a string.

B

&ZSOCINFO

Obtains information about the specific socket owned by the process.

B

&ZSUBST

Returns a string with substituted data.

B

&ZSYSPARM

Returns the value of a systems parameter (SYSPARMS).

B

&ZTCPERDS

Returns a short message for a TCP/IP error code.

B

&ZTCPERNM

Returns the logical name of a TCP/IP error code.

B

&ZTCPINFO

Obtains information about the local host or TCP/IP vendor stack.

B

&ZTCPSUPP

Determines whether the current TCP/IP vendor stack supports a function.

B

&ZUNQUOTE

Removes one level of quotes from a string and undoes &ZQUOTE.

B