VMS Help EDT Routines, XLATE  *Conan The Librarian (sorry for the slow response - running on an old VAX)

    The user-supplied XLATE routine is called by EDT when it
    encounters the nokeypad command XLATE. You cause it to be called
    by specifying it as an argument in the EDT$EDIT routine. It
    cannot be called independently.

    Format

      XLATE  string

1 - Returns

    OpenVMS usage:cond_value
    type:         longword (unsigned)
    access:       write only
    mechanism:    by value

    Longword value returned as a status code. It is generally a
    success code. If the XLATE routine cannot process the passed
    string for some reason, it sets status to an error code.
    Returning an error code from the XLATE routine aborts the current
    key execution and displays the appropriate error message.

    The condition value is returned in R0.

2 - Argument

 string

    OpenVMS usage:char_string
    type:         character-coded text string
    access:       modify
    mechanism:    by descriptor
    Text string passed to the nokeypad command XLATE. You can use the
    nokeypad command XLATE by defining a key to include the following
    command in its definition:

    XLATEtext^Z

    The text is passed by the string argument. The string argument
    can be handled by the Run-Time Library routine STR$COPY_DX.

    This argument is also a text string returned to EDT. The string
    is made up of nokeypad commands that EDT is to execute.

3 - Description

    The nokeypad command XLATE allows you to gain control of the
    EDT session. (See the OpenVMS EDT Reference Manual for more
    information about the XLATE command.) If you do not need to gain
    control of EDT during the editing session, you can use the entry
    point EDT$XLATE for this argument or you can omit it.

4 - Condition Value Returned

    SS$_NORMAL         Normal successful completion.