EQUATE primary command — create a user-defined symbol

Use the EQUATE primary command to create a user-defined symbol in the symbol table and to associate an address and address processing parameters with the symbol. If the specified symbol already exists in the symbol table, the new address and address processing parameters overlay the previous information.

• Syntax

    { EQUATE }   symbol
    { EQU    }
    { EQ     }
               [ data-descr | X ]

• Parameters

  symbol

  Specifies the symbol being defined. When specifying symbol, do not include the ampersand (&) or the period (.) that are normally part of symbolic notation. The symbol is 1 through 31 alphanumeric characters; the first character must be a letter or one of the following characters:

  $  (X'5B')
  #  (X'7B')
  @  (X'7C')

  data-descr or X

  Specifies the data description parameter, which consists of two parts:

  • An address
  • Address processing parameters

  Data description parameter has more information about the syntax and use of the data description parameter. If you omit the data description parameter, the default is X, the current address.

• Usage notes
  • EQUATE can be used only in the BROWSE option.
  • There are two special symbols, CURSOR and X, that are accepted in the BROWSE option on the storage panel. These symbols associate a location in a dump and are used in the same manner as other symbols, such as the CVT and TCB symbols.
    • CURSOR indicates the word of storage at which you position the cursor. By placing the cursor in the selection field preceding a word of storage or by placing the cursor under a word of storage, you can reference the word of storage. CURSOR is not in effect if the position of the cursor does not identify a word of storage or if you leave the storage panel.
    • X indicates the starting address of the data displayed on the storage panel. X remains in effect even if you leave the storage panel.
  • To add your user-defined symbol to the address pointer stack on the pointer panel of the BROWSE option, use the STACK primary command.
• Example 1: Set X to a specific address.
  • Action

    COMMAND ===> equate X 522836

  • Result

    X, the current address, becomes X‘522836’.

• Example 2: Equate a specific address to a user-defined symbol.
  • Action

    COMMAND ===> equate failingtcb 51368.

  • Result

    A symbol table entry is created for FAILINGTCB and is identified at address X‘51368’.