Arguments

 

key-table-id

   OpenVMS usage:identifier
   type:         longword (unsigned)
   access:       read only
   mechanism:    by reference

   Specifies the key table from which you are extracting a
   definition. 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 SMG$CREATE_KEY_TABLE.
 

key-name

   OpenVMS usage:char_string
   type:         character string
   access:       read only
   mechanism:    by descriptor

   Specifies the name of the key associated with the definition. The
   key-name argument is the address of a descriptor pointing to the
   key name.
 

if-state

   OpenVMS usage:char_string
   type:         character string
   access:       read only
   mechanism:    by descriptor

   Specifies the current state name in effect after the key is
   pressed. The if-state argument is the address of a descriptor
   pointing to the state name.

   See SMG$ADD_KEY_DEF for more information.
 

attributes

   OpenVMS usage:mask_longword
   type:         longword (unsigned)
   access:       write only
   mechanism:    by reference

   Receives the attributes bit mask for this key definition. The
   attributes argument is the address of a longword into which is
   written the bit mask describing the key's attributes.

   Valid values are as follows:

   SMG$M_KEY_NOECHO   If set, this bit specifies that equiv_string
                      is not to be echoed when this key is pressed.
                      If clear, equiv_string is echoed. If SMG$M_
                      KEY_TERMINATE is not set, SMG$M_KEY_NOECHO is
                      ignored.
   SMG$M_KEY_         If set, this bit specifies that when this key
   TERMINATE          is pressed (as qualified by if-state), the
                      input line is complete and more characters
                      should not be accepted. If clear, more
                      characters may be accepted.
   SMG$M_KEY_         If set, and if state-string is specified, the
   LOCKSTATE          state name specified by state-string remains
                      at the current state until explicitly changed
                      by a subsequent keystroke whose definition
                      includes a state-string. If clear, the state
                      name specified by state-string remains in
                      effect only for the next defined key stroke.
   SMG$M_KEY_         If set, this bit specifies that this key
   PROTECTED          definition cannot be modified or deleted.
                      If clear, the key definition can be modified
                      or deleted.
 

equivalence-string

   OpenVMS usage:char_string
   type:         character string
   access:       write only
   mechanism:    by descriptor

   Receives the equivalence string for this key definition. The
   equivalence-string argument is the address of a descriptor
   pointing to the string into which is written the equivalence
   string.
 

state-string

   OpenVMS usage:char_string
   type:         character string
   access:       write only
   mechanism:    by descriptor

   Receives the new state name, if any, which is set by this
   key definition. The state-string argument is the address of a
   descriptor pointing to the string into which is written the new
   state string.