 |
OpenVMS/Hanzi RTL Chinese Screen Management (SMG$)
Manual
SMG$DELETE_KEY_DEF
The Delete Key Definition routine deletes a key definition from the
specified table of key definitions.
Format
SMG$DELETE_KEY_DEF key-table-id ,key-name [,if-state]
RETURNS
| OpenVMS usage |
cond_value |
| type |
longword (unsigned) |
| access |
write only |
| mechanism |
by value |
Arguments
key-table-id
| OpenVMS usage |
identifier |
| type |
longword (unsigned) |
| access |
read only |
| mechanism |
by reference |
Identifies the key table from which the key definition is deleted. The
key-table-id argument is the address of an unsigned
longword that contains the key table identifier.
key-name
| OpenVMS usage |
char_string |
| type |
character string |
| access |
read only |
| mechanism |
by descriptor |
String containing the name of the key whose definition is to be
deleted. The key-name argument is the address of a
descriptor pointing to the key name. Key-name is
stripped of trailing blanks and converted to uppercase before use.
Table 3-1 in Part I of this manual lists the valid key names.
if-state
| OpenVMS usage |
char_string |
| type |
character string |
| access |
read only |
| mechanism |
by descriptor |
String containing a state name which further qualifies
key-name. The if-state argument is
the address of a descriptor pointing to the state name. If omitted, the
null state is used. Thus if a key has several definitions depending on
various values of if-state, this routine lets you
delete only one of those definitions.
Description
SMG$DELETE_KEY_DEF deletes a key definition from the specified table of
key definitions.
Condition Values Returned
|
SS$_NORMAL
|
Normal successful completion.
|
|
SMG$_INVKEYNAM
|
Invalid
key-name.
|
|
SMG$_INVKTB_ID
|
Invalid
key-table-id.
|
|
SMG$_KEYNOTDEF
|
Key is not defined.
|
|
SMG$_WRONUMARG
|
Wrong number of arguments.
|
|
SMG$_KEYDEFPRO
|
Key definition is protected.
|
SMG$DELETE_LINE
The Delete Line routine deletes lines from a virtual display.
Format
SMG$DELETE_LINE display-id ,start-row [,number-of-rows]
RETURNS
| OpenVMS usage |
cond_value |
| type |
longword (unsigned) |
| access |
write only |
| mechanism |
by value |
Arguments
display-id
| OpenVMS usage |
identifier |
| type |
longword (unsigned) |
| access |
read only |
| mechanism |
by reference |
Identifies the virtual display from which lines are to be deleted. The
display-id argument is the address of an unsigned
longword that contains the display identifier.
Display-id 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 to be deleted from the virtual display. The
start-row argument is the address of a signed longword
that contains the number of the first line to be deleted.
number-of-rows
| OpenVMS usage |
longword_signed |
| type |
longword (signed) |
| access |
read only |
| mechanism |
by reference |
Specifies the number of lines to be deleted. The
number-of-rows argument is the address of a signed
longword that contains the number of lines to be deleted. If omitted,
one line is deleted.
Description
SMG$DELETE_LINE deletes one or more lines from a virtual display and
scrolls the remaining lines up into the space created by the deletion.
Blank lines fill the display on the bottom. The virtual cursor is left
at the first column position in start-row.
Condition Values Returned
|
SS$_NORMAL
|
Normal successful completion.
|
|
SMG$_INVDIS_ID
|
Invalid
display-id.
|
|
SMG$_WRONUMARG
|
Wrong number of arguments.
|
|
SMG$_INVROW
|
Invalid row.
|
|
SMG$_INVARG
|
Invalid argument.
|
|
SMG$_WILUSERMS
|
Pasteboard is not a video terminal.
|
Example
|
C+
C This DEC Fortran example program demonstrates the use of SMG$DELETE_LINE.
C-
IMPLICIT INTEGER (A-Z)
C+
C Create the virtual display by calling SMG$CREATE_VIRTUAL_DISPLAY.
C To give it a border, set BORDER = 1. No border would be BORDER = 0.
C-
ROWS = 7
COLUMNS = 50
BORDER = 1
STATUS = SMG$CREATE_VIRTUAL_DISPLAY
1 (ROWS, COLUMNS, DISPLAY1, BORDER)
IF (.NOT. STATUS) CALL LIB$SIGNAL(%VAL(STATUS))
C+
C Call SMG$CREATE_PASTEBOARD to create the pasteboard.
C-
STATUS = SMG$CREATE_PASTEBOARD (PASTE1)
IF (.NOT. STATUS) CALL LIB$SIGNAL(%VAL(STATUS))
C+
C Use SMG$PUT_CHARS to put data in the virtual display.
C-
STATUS = SMG$PUT_CHARS ( DISPLAY1,
1 ' This virtual display has 7 rows and 50 columns.', 2, 1)
IF (.NOT. STATUS) CALL LIB$SIGNAL(%VAL(STATUS))
STATUS = SMG$PUT_CHARS ( DISPLAY1,
1 ' This is a bordered virtual display.', 4, 1)
IF (.NOT. STATUS) CALL LIB$SIGNAL(%VAL(STATUS))
STATUS = SMG$PUT_CHARS ( DISPLAY1,
1 ' SMG$PUT_CHARS puts data in this virtual display.', 6, 1)
IF (.NOT. STATUS) CALL LIB$SIGNAL(%VAL(STATUS))
C+
C Paste the virtual display to the pasteboard using
C SMG$PASTE_VIRTUAL_DISPLAY.
C-
STATUS = SMG$PASTE_VIRTUAL_DISPLAY ( DISPLAY1, PASTE1, 4, 15)
IF (.NOT. STATUS) CALL LIB$SIGNAL(%VAL(STATUS))
C+
C Call SMG$DELETE_LINE to delete rows 3, 4, and 5.
C-
STATUS = SMG$DELETE_LINE ( DISPLAY1, 3, 3)
IF (.NOT. STATUS) CALL LIB$SIGNAL(%VAL(STATUS))
END
|
The output generated by this FORTRAN program before the call to
SMG$DELETE_LINE is shown in Figure SMG-12.
Figure SMG-12 Output Generated by FORTRAN Program Before the
Call to SMG$DELETE_LINE
The output generated after the call to SMG$DELETE_LINE is shown in
Figure SMG-13.
Figure SMG-13 Output Generated After the Call to
SMG$DELETE_LINE
SMG$DELETE_MENU
The End Access to a Menu in the Virtual Display routine ends access to
the menu choices in the specified virtual display.
Format
SMG$DELETE_MENU display-id [,flags]
RETURNS
| OpenVMS usage |
cond_value |
| type |
longword (unsigned) |
| access |
write only |
| mechanism |
by value |
Arguments
display-id
| OpenVMS usage |
identifier |
| type |
longword (unsigned) |
| access |
read only |
| mechanism |
by reference |
Identifier of the virtual display in which the menu choices are
displayed. The display-id argument is the address of
an unsigned longword containing this identifier.
flags
| OpenVMS usage |
mask_longword |
| type |
longword (unsigned) |
| access |
read only |
| mechanism |
by reference |
Optional bit mask specifying possible actions to take when deleting the
menu. The flags argument is the address of an unsigned
longword that contains the flag. At this time, the only valid value is
SMG$M_ERASE_MENU. If this option is specified, all rows containing menu
items are erased.
Description
SMG$DELETE_MENU discontinues access to the menu choices in the
specified virtual display. The optional flags argument
lets you specify that the menu choices be removed from the display when
the menu is deleted.
Condition Values Returned
|
SS$_NORMAL
|
Normal successful completion.
|
|
LIB$_xxxx
|
Any condition value returned by LIB$FREE_VM.
|
|
SMG$_xxxx
|
Any condition value returned by SMG$ERASE_DISPLAY.
|
SMG$DELETE_PASTEBOARD
The Delete Pasteboard routine deletes a pasteboard.
Format
SMG$DELETE_PASTEBOARD pasteboard-id [,flags]
RETURNS
| OpenVMS usage |
cond_value |
| type |
longword (unsigned) |
| access |
write only |
| mechanism |
by value |
Arguments
pasteboard-id
| OpenVMS usage |
identifier |
| type |
longword (unsigned) |
| access |
read only |
| mechanism |
by reference |
Specifies the pasteboard to be deleted. The
pasteboard-id argument is the address of an unsigned
longword that contains the pasteboard identifier.
Pasteboard-id is returned by SMG$CREATE_PASTEBOARD.
flags
| OpenVMS usage |
mask_longword |
| type |
longword (unsigned) |
| access |
read only |
| mechanism |
by reference |
Optional bit mask specifying whether the screen is cleared after the
specified pasteboard is deleted. The flags argument is
the address of an unsigned longword that contains the flag. Valid
values are as follows:
|
0
|
Does not clear the screen.
|
|
SMG$M_ERASE_PBD
|
Clears the screen (default).
|
Description
SMG$DELETE_PASTEBOARD flushes all output to the display, terminates all
use of the specified pasteboard, and deallocates all resources
associated with the pasteboard.
Condition Values Returned
|
SS$_NORMAL
|
Normal successful completion.
|
|
SMG$_WRONUMARG
|
Wrong number of arguments.
|
|
SMG$_INVPAS_ID
|
Invalid
pasteboard-id.
|
|
SMG$_NOTPASTED
|
The specified virtual display is not pasted to the specified pasteboard.
|
|
SMG$_WILUSERMS
|
Pasteboard is not a video terminal.
|
Any condition values returned by $DASSGN, LIB$FREE_VM, LIB$FREE_EF, or
SMG$FLUSH_BUFFER.
SMG$DELETE_SUBPROCESS
The Terminate a Subprocess routine deletes a subprocess that was
created with the SMG$CREATE_SUBPROCESS routine.
Format
SMG$DELETE_SUBPROCESS display-id
RETURNS
| OpenVMS usage |
cond_value |
| type |
longword (unsigned) |
| access |
write only |
| mechanism |
by value |
Arguments
display-id
| OpenVMS usage |
identifier |
| type |
longword (unsigned) |
| access |
read only |
| mechanism |
by reference |
Identifier of the virtual display associated with the subprocess being
deleted. The display-id argument is the address of an
unsigned longword that contains this virtual display identifier.
Description
SMG$DELETE_SUBPROCESS deletes a subprocess that was created by a call
to SMG$CREATE_SUBPROCESS. Because the Screen Management Facility
provides its own exit handlers, do not invoke SMG$DELETE_SUBPROCESS
from within your own exit handler. For more information, see
Section 4.4 in Chapter 4.
Condition Values Returned
|
SS$_NORMAL
|
Normal successful completion.
|
|
SMG$_NOSUBEXI
|
No subprocess exists.
|
|
SMG$_INVDIS_ID
|
Invalid
display-id.
|
|
LIB$_xxxx
|
Any status returned by LIB$FREE_VM.
|
|
SS$_xxxx
|
Any status returned by $DELPRC.
|
SMG$DELETE_VIEWPORT
The Delete a Viewport routine deletes the specified viewport from any
pasteboards to which it is pasted.
Format
SMG$DELETE_VIEWPORT display-id
RETURNS
| OpenVMS usage |
cond_value |
| type |
longword (unsigned) |
| access |
write only |
| mechanism |
by value |
Arguments
display-id
| OpenVMS usage |
identifier |
| type |
longword (unsigned) |
| access |
read only |
| mechanism |
by reference |
Identifier of the virtual display associated with the viewport to be
deleted. The display-id argument is the address of an
unsigned longword containing the display identifier.
Description
SMG$DELETE_VIEWPORT deletes a viewport. The viewport is automatically
"unpasted" from any pasteboards to which it is pasted.
However, the virtual display associated with the deleted viewport has
not been deleted. To view this virtual display, you must paste it to
the pasteboard with the SMG$PASTE_VIRTUAL_DISPLAY routine. To delete
this virtual display, use the SMG$DELETE_VIRTUAL_DISPLAY routine.
Condition Values Returned
|
SS$_NORMAL
|
Normal successful completion.
|
|
SMG$_INVDIS_ID
|
Invalid
display-id.
|
|
SMG$_NO_WINASSOC
|
No viewport associated with the virtual display.
|
|
SMG$_WRONUMARG
|
Wrong number of arguments.
|
SMG$DELETE_VIRTUAL_DISPLAY
The Delete Virtual Display routine deletes a virtual display.
Format
SMG$DELETE_VIRTUAL_DISPLAY display-id
RETURNS
| OpenVMS usage |
cond_value |
| type |
longword (unsigned) |
| access |
write only |
| mechanism |
by value |
Arguments
display-id
| OpenVMS usage |
identifier |
| type |
longword (unsigned) |
| access |
read only |
| mechanism |
by reference |
Specifies the virtual display to be deleted. The
display-id argument is the address of an unsigned
longword that contains the display identifier.
Display-id is returned by SMG$CREATE_VIRTUAL_DISPLAY.
Description
SMG$DELETE_VIRTUAL_DISPLAY deletes a virtual display and removes it
from any pasteboard on which it is pasted. It also deallocates any
buffer space associated with the virtual display.
Condition Values Returned
|
SS$_NORMAL
|
Normal successful completion.
|
|
SMG$_INVDIS_ID
|
Invalid
display-id.
|
|
SMG$_WILUSERMS
|
Pasteboard is not a video terminal.
|
|
SMG$_WRONUMARG
|
Wrong number of arguments.
|
|
SMG$_NOTPASTED
|
The specified virtual display is not pasted to the specified pasteboard.
|
Any condition values returned by LIB$FREE_VM.
SMG$DELETE_VIRTUAL_KEYBOARD
The Delete Virtual Keyboard routine deletes a virtual keyboard.
Format
SMG$DELETE_VIRTUAL_KEYBOARD keyboard-id
RETURNS
| OpenVMS usage |
cond_value |
| type |
longword (unsigned) |
| access |
write only |
| mechanism |
by value |
Arguments
keyboard-id
| OpenVMS usage |
identifier |
| type |
longword (unsigned) |
| access |
read only |
| mechanism |
by reference |
Specifies the virtual keyboard to be deleted. The
keyboard-id argument is the address of an unsigned
longword that contains the keyboard identifier.
Keyboard-id is returned by SMG$CREATE_VIRTUAL_KEYBOARD.
Description
SMG$DELETE_VIRTUAL_KEYBOARD deletes a virtual keyboard. Any terminal
attributes specified when the keyboard was created are reset to their
previous values and the keypad mode (numeric or application) is reset
to its original state. In addition, the channel is deassigned.
Because SMG$ provides its own exit handlers, this routine should not be
called from your own exit handler.
Condition Values Returned
|
SS$_NORMAL
|
Normal successful completion.
|
|
SMG$_INVKBD_ID
|
Invalid
keyboard-id.
|
|
SMG$_WRONUMARG
|
Wrong number of arguments.
|
|
