/sys$common/syshlp/SDA.HLB  —  DEFINE
    The DEFINE command performs two functions:

    o  Assigns a value to a symbol (see subtopic "symbol"). For this
       function, the /FD or /PD qualifier can optionally be selected.

    o  Associates an SDA command with a terminal key (see /KEY).
       Several other qualifiers can be specified with /KEY.

    If the symbol or key is already defined, SDA replaces the old
    definition with the new one. Symbols and keys remain defined
    until you exit from SDA.

1  –  symbol 

    Assigns a value to a symbol.

    Format

      DEFINE  [/qualifier...] symbol-name [=] expression

1.1  –  Parameters 

 symbol-name

    Name, containing from 1 to 31 alphanumeric characters, that
    identifies the symbol. Symbols that include lowercase letters
    must be enclosed in quotation marks ("symbol" ).

 expression

    Definition of the symbol's value.

1.2  –  Qualifier

1.2.1    /FD 

       /FD
       /PD

    Defines a symbol as a function descriptor (FD) or procedure
    descriptor (PD). It also defines the routine address symbol
    corresponding to the defined symbol (the routine address symbol
    has the same name as the defined symbol, only with _C appended to
    the symbol name). /FD and /PD are completely interchangeable. SDA
    interprets them based on the architecture of the system or dump
    being analyzed.

1.2.2    /PD 

    /PD is functionally equivalent to /FD. See /FD for details.

2    /KEY 

    Associates an SDA command with a terminal key.

    Once you have associated a command with a key, you can just press
    the defined key, followed by the Return key to issue the command.
    If you specify the /TERMINATE qualifier when you define the key,
    you do not have to press the Return key to issue the command.

    Format

      DEFINE/KEY  [/qualifier...] key-name command

2.1  –  Parameters 

 key-name

    Name of the key to be defined. You can define the following keys
    under SDA:

    Key Name   Key Designation

    PF1        LK201, VT100
    PF2        LK201, VT100
    PF3        LK201, VT100
    PF4        LK201, VT100
    KP0 . . .  Keypad 0-9
    KP9
    PERIOD     Keypad period
    COMMA      Keypad comma
    MINUS      Keypad minus
    ENTER      Keypad ENTER
    UP         Up arrow
    DOWN       Down arrow
    LEFT       Left arrow
    RIGHT      Right arrow
    E1         LK201 Find
    E2         LK201 Insert Here
    E3         LK201 Remove
    E4         LK201 Select
    E5         LK201 Prev Screen
    E6         LK201 Next Screen
    HELP       LK201 Help
    DO         LK201 Do
    F7 . . .   LK201 Function keys
    F20

 command

    SDA command to define a key. You must enclose the command in
    quotation marks (" ").

2.2  –  Qualifiers

2.2.1    /IF_STATE 

       /IF_STATE=state_list
       /NOIF_STATE

    Specifies a list of one or more states, one of which must be in
    effect for the key definition to work. The /NOIF_STATE qualifier
    has the same meaning as /IF_STATE=current_state. The state name
    is an alphanumeric string. States are established with the /SET_
    STATE qualifier. If you specify only one state name, you can omit
    the parentheses. By including several state names, you can define
    a key to have the same function in all the specified states.

2.2.2    /LOCK_STATE 

       /LOCK_STATE
       /NOLOCK_STATE

    Specifies that the state set by the /SET_STATE qualifier remains
    in effect until explicitly changed. By default, the /SET_STATE
    qualifier is in effect only for the next definable key you press
    or the next read-terminating character that you type. You can
    specify this qualifier only with the /SET_STATE qualifier.

    The default is /NOLOCK_STATE.

2.2.3    /SET_STATE 

       /SET_STATE=state-name
       /NOSET_STATE

    Causes the key being defined to create a key state change instead
    of or in addition to issuing an SDA command. When you use the
    /SET_STATE qualifier, you supply the name of a key state to be
    used with the /IF_STATE qualifier in other key definitions.

    For example, you can define the PF1 key as the GOLD key and use
    the /IF_STATE=GOLD qualifier to allow two definitions for the
    other keys, one in the GOLD state and one in the non-GOLD state.
    For more information on using the /IF_STATE qualifier, see the
    DEFINE/KEY command in the OpenVMS DCL Dictionary or online help.

    The default is /NOSET_STATE.

2.2.4    /TERMINATE 

       /TERMINATE
       /NOTERMINATE

    Causes the key definition to include termination of the command,
    which causes SDA to execute the command when the defined key
    is pressed. Therefore, you do not have to press the Return key
    after you press the defined key if you specify the /TERMINATE
    qualifier.
Close Help