[SWEXA.WRK]SWEXA_MAILBOX.RNH

.ap
.flag accept ~
.lm +2
.paragraph 0
.rm 70

.i -2;1 MAILBOX

The MAILBOX commands perform the following functions:
.ls,"o"
.le;Create a mailbox (see /CREATE).
.le;Read a message form a mailbox (see /READ).
.le;Rewrite existing messages in a mailbox (see /REWRITE).
.le;Write a message to a mailbox (see /WRITE).
.els

.sk;.i -2;2 /CREATE

Create a mailbox.

Format:

##MAILBOX/CREATE logical-name

.sk;.i -2;3 Parameters
.lm +1
.sk;.i -2;logical-name

Specifies the logical name to be defined with an equivalence of the mailbox device name.
.lm -1

.sk;.i -2;3 Qualifiers

.sk;.i -2;/ERROR
.sk;.i -1;/ERROR=label-name

Specifies a label on a line  in  the  command  procedure  to  receive
control  if  the  creation results  in an error.  If no error
routine is specified and an error occurs during the creating of  the
mailbox, the current ON condition action is taken.

The error routine specified for this qualifier takes precedence over
any action statement indicated in an ON command.

If an error occurs and control passes  successfully  to  the  target
label,  the  reserved global symbol $STATUS retains the code for the
error that caused the error path to be taken.

.sk;.i -2;/EXECUTIVE_MODE

Requires SYSNAM (system logical name) privilege to create an
executive-mode mailbox.

Creates an executive-mode mailbox and logical name.

.sk;.i -2;/SUPERVISOR_MODE

Creates a supervisor-mode mailbox and logical name.

.sk;.i -2;/USER_MODE (default)

Creates a user-mode mailbox and logical name.

.sk;.i -2;2 /READ

Read a message form a mailbox.

Format:

##MAILBOX/READ mailbox symbol-name

.sk;.i -2;3 Parameters
.lm +1
.sk;.i -2;mailbox

Specifies the mailbox from which a message will be read.
.sk;.i -2;symbol-name

Specifies a 1- through 255-alphanumeric character symbol name to  be
equated  to  the  contents  of the message being read.  A symbol name
must start with an alphabetic letter, underscore, or dollar sign.

By default, the  MAILBOX/READ  command places the symbol name in the local
symbol table for the  current command level. See the /GLOBAL and /LOCAL
qualifiers for more details.
If the symbol is already defined,  the  MAILBOX/READ
command redefines it to the new value being read.
.lm -1
.sk;.i -2;3 Qualifiers

.sk;.i -2;/ERROR
.sk;.i -1;/ERROR=label-name

Specifies a label on a line  in  the  command  procedure  to  receive
control  if  the  read request results  in an error.  If no error
routine is specified and an error occurs during the reading of  the
mailbox, the current ON condition action is taken.

The error routine specified for this qualifier takes precedence over
any action statement indicated in an ON command.

If an error occurs and control passes  successfully  to  the  target
label,  the  reserved global symbol $STATUS retains the code for the
error that caused the error path to be taken.
.sk;.i -2;/GLOBAL
.sk;.i -2;/LOCAL
.sk;.i -2;/WAIT

.sk;.i -2;2 /REWRITE

Rewrite existing messages in a mailbox.

.sk;.i -2;3 Expression

Write an expression and then rewrite existing messages in a mailbox.

Format:

##MAILBOX/REWRITE mailbox expression

.sk;.i -2;4 Parameters
.lm +1
.sk;.i -2;mailbox

Specifies the mailbox from which messages will be read and rewritten to.
.sk;.i -2;expression
.lm -1
.sk;.i -2;4 Qualifiers

.sk;.i -2;/ERROR
.sk;.i -1;/ERROR=label-name

Specifies a label on a line  in  the  command  procedure  to  receive
control  if  the  rewrite request results  in an error.  If no error
routine is specified and an error occurs during the rewriting of  the
mailbox, the current ON condition action is taken.

The error routine specified for this qualifier takes precedence over
any action statement indicated in an ON command.

If an error occurs and control passes  successfully  to  the  target
label,  the  reserved global symbol $STATUS retains the code for the
error that caused the error path to be taken.

.sk;.i -2;3 Symbol

Write a symbol value and then rewrite existing messages in a mailbox.

Format:

##MAILBOX/REWRITE/SYMBOL mailbox symbol

.sk;.i -2;4 Parameters
.lm +1
.sk;.i -2;mailbox

Specifies the mailbox from which messages will be read and rewritten to.
.sk;.i -2;symbol

Specifies the name of a symbol whose value is to be written to the mailbox before the rewritten
records.
.lm -1
.sk;.i -2;4 Qualifiers

.sk;.i -2;/ERROR
.sk;.i -1;/ERROR=label-name

Specifies a label on a line  in  the  command  procedure  to  receive
control  if  the  rewrite request results  in an error.  If no error
routine is specified and an error occurs during the rewriting of  the
mailbox, the current ON condition action is taken.

The error routine specified for this qualifier takes precedence over
any action statement indicated in an ON command.

If an error occurs and control passes  successfully  to  the  target
label,  the  reserved global symbol $STATUS retains the code for the
error that caused the error path to be taken.

.sk;.i -2;2 /WRITE

Write a message to a mailbox.

.sk;.i -2;3 Expression

Write an expression to a mailbox.

Format:

##MAILBOX/WRITE mailbox expression[,...]

.sk;.i -2;4 Parameters
.lm +1
.sk;.i -2;mailbox

Specifies the mailbox to which a message will be written.
.sk;.i -2;expression
.lm -1

.sk;.i -2;4 Qualifiers

.sk;.i -2;/ERROR
.sk;.i -1;/ERROR=label-name

Specifies a label on a line  in  the  command  procedure  to  receive
control  if  the  write request results  in an error.  If no error
routine is specified and an error occurs during the writing of  the
mailbox, the current ON condition action is taken.

The error routine specified for this qualifier takes precedence over
any action statement indicated in an ON command.

If an error occurs and control passes  successfully  to  the  target
label,  the  reserved global symbol $STATUS retains the code for the
error that caused the error path to be taken.

.sk;.i -2;/WAIT

.sk;.i -2;3 Symbol

Write a symbol value to a mailbox.

Format:

##MAILBOX/WRITE/SYMBOL mailbox symbol

.sk;.i -2;4 Parameters
.lm +1
.sk;.i -2;mailbox

Specifies the mailbox to which a message will be written.
.sk;.i -2;symbol

Specifies the name of the symbol whose value is to be written to the mailbox.
.lm -1

.sk;.i -2;4 Qualifiers

.sk;.i -2;/ERROR
.sk;.i -1;/ERROR=label-name

Specifies a label on a line  in  the  command  procedure  to  receive
control  if  the  write request results  in an error.  If no error
routine is specified and an error occurs during the writing of  the
mailbox, the current ON condition action is taken.

The error routine specified for this qualifier takes precedence over
any action statement indicated in an ON command.

If an error occurs and control passes  successfully  to  the  target
label,  the  reserved global symbol $STATUS retains the code for the
error that caused the error path to be taken.

.sk;.i -2;/WAIT
.lm -2