109 – SMG$SET_BROADCAST_TRAPPING
The Enable Broadcast Trapping routine enables the trapping of
broadcast messages.
Format
SMG$SET_BROADCAST_TRAPPING pasteboard-id [,AST-routine]
[,AST-argument]
109.1 – Returns
OpenVMS usage:cond_value
type: longword (unsigned)
access: write only
mechanism: by value
109.2 – Arguments
pasteboard-id
OpenVMS usage:identifier
type: longword (unsigned)
access: read only
mechanism: by reference
Specifies the pasteboard for which broadcast messages are to be
trapped. The pasteboard-id argument is the address of an unsigned
longword that contains the pasteboard identifier.
The pasteboard identifier is returned by SMG$CREATE_PASTEBOARD.
AST-routine
OpenVMS usage:ast_procedure
type: procedure value
access: read only
mechanism: by value
The address of an AST routine to be called when a message is
received at the pasteboard. The AST-routine argument is the
address of the routine's procedure value.
When the AST-routine argument is either omitted or is given a
value of 0, the BROADCAST mode is set to synchronize. In this
mode, you must periodically call SMG$GET_BROADCAST_MESSAGE to see
if any broadcast messages have arrived.
The AST routine is called with five parameters: AST-argument, R0,
R1, PC, and PSL (on VAX systems) or PS (on Alpha systems).
AST-argument
OpenVMS usage:user_arg
type: longword (unsigned)
access: read only
mechanism: by value
A value to be passed to the AST routine. The AST-argument is an
unsigned longword that contains the value to be passed to the AST
routine.
110 – SMG$SET_CURSOR_ABS
The Set Absolute Cursor Position routine moves the virtual cursor
to the specified position in a virtual display.
Format
SMG$SET_CURSOR_ABS display-id [,start-row] [,start-column]
110.1 – Returns
OpenVMS usage:cond_value
type: longword (unsigned)
access: write only
mechanism: by value
110.2 – Arguments
display-id
OpenVMS usage:identifier
type: longword (unsigned)
access: read only
mechanism: by reference
Specifies the virtual display in which to set the virtual cursor
position. The display-id argument is the address of an unsigned
longword that contains the display identifier.
The display identifier is returned by SMG$CREATE_VIRTUAL_DISPLAY.
start-row
OpenVMS usage:longword_signed
type: longword (signed)
access: read only
mechanism: by reference
Specifies the row position to which the virtual cursor moves.
The start-row argument is the address of a signed longword that
contains the row number. If omitted, the cursor remains at the
current row.
start-column
OpenVMS usage:longword_signed
type: longword (signed)
access: read only
mechanism: by reference
Specifies the column position to which the virtual cursor moves.
The start-column argument is the address of a signed longword
that contains the column number. If omitted, the virtual cursor
remains at the current column.
111 – SMG$SET_CURSOR_MODE
The Set the Cursor Mode routine turns the physical cursor on or
off and selects jump or smooth scrolling.
Format
SMG$SET_CURSOR_MODE pasteboard-id ,flags
111.1 – Returns
OpenVMS usage:cond_value
type: longword (unsigned)
access: write only
mechanism: by value
111.2 – Arguments
pasteboard-id
OpenVMS usage:identifier
type: longword (unsigned)
access: read only
mechanism: by reference
Pasteboard identifier. The pasteboard-id argument is the address
of an unsigned longword that contains the pasteboard identifier.
flags
OpenVMS usage:mask_longword
type: longword (unsigned)
access: read only
mechanism: by reference
Optional bit mask that specifies scrolling and cursor attributes.
The flags argument is the address of an unsigned longword that
contains the flag. The flags argument accepts the following
values:
SMG$M_CURSOR_OFF Clears physical cursor.
SMG$M_CURSOR_ON Displays physical cursor.
SMG$M_SCROLL_JUMP Jump scrolls.
SMG$M_SCROLL_ Smooth scrolls.
SMOOTH
112 – SMG$SET_CURSOR_REL
The Move Cursor Relative to Current Position routine moves the
virtual cursor the specified number of rows and columns from the
current virtual cursor position in a virtual display.
Format
SMG$SET_CURSOR_REL display-id [,delta-row] [,delta-column]
112.1 – Returns
OpenVMS usage:cond_value
type: longword (unsigned)
access: write only
mechanism: by value
112.2 – Arguments
display-id
OpenVMS usage:identifier
type: longword (unsigned)
access: read only
mechanism: by reference
Specifies the virtual display in which to move the virtual
cursor. The display-id argument is the address of an unsigned
longword that contains the display identifier.
The display identifier is returned by SMG$CREATE_VIRTUAL_DISPLAY.
delta-row
OpenVMS usage:longword_signed
type: longword (signed)
access: read only
mechanism: by reference
Specifies the number of rows to move the virtual cursor. The
delta-row argument is the address of a signed longword that
contains the number of rows to move. If omitted, the virtual
cursor remains at the current row position. If delta-row is
positive, the virtual cursor moves downward the specified number
of rows. If delta-row is negative, the virtual cursor moves
upward the specified number of rows.
delta-column
OpenVMS usage:longword_signed
type: longword (signed)
access: read only
mechanism: by reference
Specifies the number of columns to move the cursor. The delta-
column argument is the address of a signed longword that contains
the number of columns to move. If omitted, the virtual cursor
remains at the current column position. If delta-column is
positive, the virtual cursor moves the specified number of
columns to the right. If delta-column is negative, the virtual
cursor moves the specified number of columns to the left.
113 – SMG$SET_DEFAULT_STATE
The Set Default State routine sets and/or returns the current
default state for a key table.
Format
SMG$SET_DEFAULT_STATE key-table-id [,new-state] [,old-state]
113.1 – Returns
OpenVMS usage:cond_value
type: longword (unsigned)
access: write only
mechanism: by value
113.2 – Arguments
key-table-id
OpenVMS usage:identifier
type: longword (unsigned)
access: read only
mechanism: by reference
Specifies the key table in which you are setting or inquiring
about a default state. The key-table-id argument is the address
of an unsigned longword that contains the key table identifier.
The key table identifier is returned by the SMG$CREATE_KEY_TABLE
routine.
new-state
OpenVMS usage:char_string
type: character string
access: read only
mechanism: by descriptor
Specifies the new default state for the entire key table. The
new-state argument is the address of a descriptor pointing to
the new state string. The specified state name is converted to
uppercase and stripped of trailing blanks before use.
old-state
OpenVMS usage:char_string
type: character string
access: write only
mechanism: by descriptor
Receives the existing default state name of the specified key
definition table. The old-state argument is the address of a
descriptor pointing to the string into which the old state string
is written.
114 – SMG$SET_DISPLAY_SCROLL_REGION
The Create Display Scrolling Region routine creates a virtual
scrolling region in a virtual display.
Format
SMG$SET_DISPLAY_SCROLL_REGION display-id [,start-row]
[,end-row]
114.1 – Returns
OpenVMS usage:cond_value
type: longword (unsigned)
access: write only
mechanism: by value
114.2 – Arguments
display-id
OpenVMS usage:identifier
type: longword (unsigned)
access: read only
mechanism: by reference
Specifies the virtual display in which scrolling takes place. The
display-id argument is the address of an unsigned longword that
contains the display identifier.
The display identifier is returned by SMG$CREATE_VIRTUAL_DISPLAY.
start-row
OpenVMS usage:longword_signed
type: longword (signed)
access: read only
mechanism: by reference
Specifies the first line of the virtual scrolling region. The
start-row argument is the address of a signed longword that
contains the starting line number. If omitted, the first line
of the display is used.
end-row
OpenVMS usage:longword_signed
type: longword (signed)
access: read only
mechanism: by reference
Specifies the last line of the virtual scrolling region. The end-
row argument is the address of a signed longword that contains
the ending line number. If omitted, the last line of the virtual
display is used.
115 – SMG$SET_KEYPAD_MODE
The Set Keypad Mode routine sets the terminal's numeric keypad to
either numeric or applications mode.
Format
SMG$SET_KEYPAD_MODE keyboard-id ,flags
115.1 – Returns
OpenVMS usage:cond_value
type: longword (unsigned)
access: write only
mechanism: by value
115.2 – Arguments
keyboard-id
OpenVMS usage:identifier
type: longword (unsigned)
access: read only
mechanism: by reference
Specifies the virtual keyboard whose mode is to be changed. The
keyboard-id argument is the address of an unsigned longword that
contains the keyboard identifier.
The keyboard identifier is returned by SMG$CREATE_VIRTUAL_
KEYBOARD.
flags
OpenVMS usage:mask_longword
type: longword (unsigned)
access: read only
mechanism: by reference
Optional bit mask that specifies whether the keypad is to be in
applications or numeric mode. The flags argument is the address
of an unsigned longword that contains the flag. Valid values for
flags are as follows:
0 Keypad is set to numeric mode.
SMG$M_KEYPAD_ Keypad is set to applications mode.
APPLICATION
116 – SMG$SET_OUT_OF_BAND_ASTS
The Set Out-of-Band ASTs routine either enables or disables the
trapping of out-of-band control characters.
Format
SMG$SET_OUT_OF_BAND_ASTS pasteboard-id,control-character-mask
,AST-routine [,AST-argument]
116.1 – Returns
OpenVMS usage:cond_value
type: longword (unsigned)
access: write only
mechanism: by value
116.2 – Arguments
pasteboard-id
OpenVMS usage:identifier
type: longword (unsigned)
access: read only
mechanism: by reference
Specifies the pasteboard for which out-of-band characters are
enabled or disabled. The pasteboard-id argument is the address of
an unsigned longword that contains the pasteboard identifier.
The pasteboard identifier is returned by SMG$CREATE_PASTEBOARD.
control-character-mask
OpenVMS usage:mask_longword
type: longword (unsigned)
access: read only
mechanism: by reference
Specifies which control characters are to be the new out-of-band
control characters. The control-character-mask argument is the
address of an unsigned longword that contains the mask. Create
this mask by setting the bit that corresponds to the ASCII value
of the desired character. For example, to specify that Ctrl/C
(ASCII value 3) is an out-of-band control character, set bit 3
(value 8) in the control-character-mask. If no bits are set in
this mask, then no out-of-band ASTs occur. For more information,
see the OpenVMS I/O User's Reference Manual.
AST-routine
OpenVMS usage:ast_procedure
type: procedure value
access: read only
mechanism: by value
The address of an AST routine to be called when an out-of-band
control character is typed at the terminal. The AST-routine
argument is the routine's procedure value.
AST-argument
OpenVMS usage:user_arg
type: longword (unsigned)
access: read only
mechanism: by value
The argument you supply to the AST. AST-argument is an unsigned
longword that contains the value to be passed to the AST routine.
However, the AST routine may also need to determine the out-
of-band character and the pasteboard-id at which it was typed.
Therefore, the Screen Management Facility creates a three-
longword structure to hold this information and passes the
address of this structure as the first argument to the AST
routine. The remaining four arguments are R0, R1, PC, and PSL
(on VAX systems) or PS (on Alpha systems). The Screen Management
Facility stores the argument you supply in this structure.
+---------------------------+ +-------------------------+
| address of data structure |--------->| SMG$L_PBD_ID |
+---------------------------+ +-------------------------+
| R0 | | SMG$L_USER_ARG |
+---------------------------+ +-------------------------+
| R1 | | SMG$L_CHAR |
+---------------------------+ +-------------------------+
| PC |
+---------------------------+
| PSL |
+---------------------------+
The first longword contains the pasteboard-id and has the
symbolic name SMG$L_PBD_ID. The second longword contains the
AST-argument and has the symbolic name SMG$L_USER_ARG. The third
longword contains the ASCII value of the out-of-band character
typed and can be accessed by way of two symbolic names: SMG$B_
CHAR (the low-order byte containing the ASCII value), and SMG$L_
CHAR (the longword containing the ASCII value in the low-order
byte and spaces in the high-order bytes).
117 – SMG$SET_PHYSICAL_CURSOR
The Set Cursor on Physical Screen routine moves the physical
cursor to the specified position on the pasteboard.
Format
SMG$SET_PHYSICAL_CURSOR pasteboard-id ,pasteboard-row
,pasteboard-column
117.1 – Returns
OpenVMS usage:cond_value
type: longword (unsigned)
access: write only
mechanism: by value
117.2 – Arguments
pasteboard-id
OpenVMS usage:identifier
type: longword (unsigned)
access: read only
mechanism: by reference
Specifies the pasteboard whose physical cursor is to move. The
pasteboard-id argument is the address of an unsigned longword
that contains the pasteboard identifier.
The pasteboard identifier is returned by SMG$CREATE_PASTEBOARD.
pasteboard-row
OpenVMS usage:longword_signed
type: longword (signed)
access: read only
mechanism: by reference
Specifies the row to which the physical cursor moves. The
pasteboard-row argument is the address of a signed longword that
contains the row number.
pasteboard-column
OpenVMS usage:longword_signed
type: longword (signed)
access: read only
mechanism: by reference
Specifies the column to which the physical cursor moves. The
pasteboard-column argument is the address of a signed longword
that contains the column number.
118 – SMG$SET_TERM_CHARACTERISTICS
The Change Terminal Characteristics routine changes or retrieves
the terminal characteristics for a given pasteboard.
Format
SMG$SET_TERM_CHARACTERISTICS pasteboard-id
[,on-characteristics1]
[,on-characteristics2]
[,off-characteristics1]
[,off-characteristics2]
[,old-characteristics1]
[,old-characteristics2]
[,on-characteristics3]
[,off-characteristics3]
[,old-characteristics3]
118.1 – Returns
OpenVMS usage:cond_value
type: longword (unsigned)
access: write only
mechanism: by value
118.2 – Arguments
pasteboard-id
OpenVMS usage:identifier
type: longword (unsigned)
access: read only
mechanism: by reference
Specifies the pasteboard whose characteristics are to be changed
or retrieved. The pasteboard-id argument is the address of an
unsigned longword that contains the pasteboard identifier.
The pasteboard identifier is returned by SMG$CREATE_PASTEBOARD.
on-characteristics1
OpenVMS usage:mask_longword
type: longword (unsigned)
access: read only
mechanism: by reference
Bit mask that specifies the terminal characteristics to be set
from $TTDEF. The on-characteristics1 argument is the address of
an unsigned longword that contains the bit mask.
on-characteristics2
OpenVMS usage:mask_longword
type: longword (unsigned)
access: read only
mechanism: by reference
Bit mask that specifies the terminal characteristics to be set
from $TT2DEF. The on-characteristics2 argument is the address of
an unsigned longword that contains the bit mask.
off-characteristics1
OpenVMS usage:mask_longword
type: longword (unsigned)
access: read only
mechanism: by reference
Bit mask that specifies the terminal characteristics to be reset
from $TTDEF. The off-characteristics1 argument is the address of
an unsigned longword that contains the bit mask.
off-characteristics2
OpenVMS usage:mask_longword
type: longword (unsigned)
access: read only
mechanism: by reference
Bit mask that specifies the terminal characteristics to be reset
from $TT2DEF. The off-characteristics2 argument is the address of
an unsigned longword that contains the bit mask.
old-characteristics1
OpenVMS usage:mask_longword
type: longword (unsigned)
access: write only
mechanism: by reference
Retrieves the current terminal characteristics in the first
group. The old-characteristics1 argument is the address of an
unsigned longword that contains the bit mask.
old-characteristics2
OpenVMS usage:mask_longword
type: longword (unsigned)
access: write only
mechanism: by reference
Retrieves the current terminal characteristics in the second
group. The old-characteristics2 argument is the address of an
unsigned longword that contains the bit mask.
on-characteristics3
OpenVMS usage:mask_longword
type: longword (unsigned)
access: read only
mechanism: by reference
Bit mask that specifies the terminal characteristics to be set
from $TT3DEF. The on-characteristics3 argument is the address of
an unsigned longword that contains the bit mask.
off-characteristics3
OpenVMS usage:mask_longword
type: longword (unsigned)
access: read only
mechanism: by reference
Bit mask that specifies the terminal characteristics to be reset
from $TT3DEF. The off-characteristics3 argument is the address of
an unsigned longword that contains the bit mask.
old-characteristics3
OpenVMS usage:mask_longword
type: longword (unsigned)
access: write only
mechanism: by reference
Retrieves the current terminal characteristics in the third
group. The old-characteristics3 argument is the address of an
unsigned longword that contains the bit mask.
119 – SMG$SNAPSHOT
The Write Snapshot routine writes the current pasteboard buffer
to the file or hardcopy terminal specified by the pasteboard
identifier.
Format
SMG$SNAPSHOT pasteboard-id [,flags]
119.1 – Returns
OpenVMS usage:cond_value
type: longword (unsigned)
access: write only
mechanism: by value
119.2 – Arguments
pasteboard-id
OpenVMS usage:identifier
type: longword (unsigned)
access: read only
mechanism: by reference
Specifies the file or hardcopy terminal to receive the contents
of the pasteboard buffer. The pasteboard-id argument is the
address of an unsigned longword that contains the pasteboard
identifier. The output device associated with pasteboard-id is
specified by the output-device argument of SMG$CREATE_PASTEBOARD.
flags
OpenVMS usage:mask_longword
type: longword (unsigned)
access: read only
mechanism: by reference
Optional bit mask that specifies whether a form feed is passed.
The flags argument is the address of an unsigned longword
containing the flag. Valid values for flags are as follows:
0 No form feed is passed.
SMG$M_FORM_FEED The first line passed is a form feed.
120 – SMG$SNAPSHOT_TO_PRINTER
The Write Snapshot to Printer routine writes the current
pasteboard buffer to the printer attached to the terminal.
Format
SMG$SNAPSHOT_TO_PRINTER pasteboard-id ,device-type [,flags]
120.1 – Returns
OpenVMS usage:cond_value
type: longword (unsigned)
access: write only
mechanism: by value
120.2 – Arguments
pasteboard-id
OpenVMS usage:identifier
type: longword (unsigned)
access: read only
mechanism: by reference
Identifier of the pasteboard whose snapshot will be sent to a
printer. The pasteboard-id argument is the address of an unsigned
longword that contains the pasteboard identifier.
device-type
OpenVMS usage:device_name
type: character string
access: read only
mechanism: by descriptor
Specifies the type of printer to which the output associated with
this pasteboard will be written. The device-type argument is the
address of a descriptor that points to the name of the output
device. Valid values for this argument (for example, LA50) are
defined in SYS$SYSTEM:TERMTABLE.TXT.
flags
OpenVMS usage:mask_longword
type: longword (unsigned)
access: read only
mechanism: by reference
Optional bit mask that specifies whether a form feed is passed.
The flags argument is the address of an unsigned longword
containing the flag. The valid value for the flags argument is
as follows:
SMG$M_FORM_FEED Output a form feed as the first record.
121 – SMG$UNPASTE_VIRTUAL_DISPLAY
The Remove Virtual Display routine removes a virtual display from
a pasteboard.
Format
SMG$UNPASTE_VIRTUAL_DISPLAY display-id ,pasteboard-id
121.1 – Returns
OpenVMS usage:cond_value
type: longword (unsigned)
access: write only
mechanism: by value
121.2 – Arguments
display-id
OpenVMS usage:identifier
type: longword (unsigned)
access: read only
mechanism: by reference
Specifies the virtual display to be removed from a pasteboard.
The display-id argument is the address of an unsigned longword
that contains the display identifier.
The display identifier is returned by SMG$CREATE_VIRTUAL_DISPLAY.
pasteboard-id
OpenVMS usage:identifier
type: longword (unsigned)
access: read only
mechanism: by reference
Specifies the pasteboard from which the virtual display is
removed. The pasteboard-id argument is the address of an unsigned
longword that contains the pasteboard identifier.