VMS Help  —  CLI Routines, CLI$DISPATCH
    The CLI$DISPATCH routine invokes the subroutine associated with
    the verb most recently parsed by a CLI$DCL_PARSE routine call.

    Format

      CLI$DISPATCH  [userarg]

1  –  Returns

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

    Longword condition value. Most utility routines return a
    condition value in R0. The condition value that this routine
    can return is listed under Condition Values Returned.

2  –  Argument

 userarg

    OpenVMS usage:longword_unsigned
    type:         longword (unsigned)
    access:       read only
    mechanism:    by value
    Data to be passed to the action routine. The userarg argument
    is a longword that contains the data to be passed to the action
    routine. This data can be used in any way you want.

3  –  Description

    The CLI$DISPATCH routine invokes the subroutine associated with
    the verb most recently parsed by a CLI$DCL_PARSE routine call.
    If the routine is successfully invoked, the return status is the
    status returned by the action routine. Otherwise, a status of
    CLI$_INVROUT is returned.

4  –  Condition Values Returned

    CLI$_INVREQTYP     Calling process did not have a CLI to perform
                       this function or the CLI did not support the
                       request.
    CLI$_INVROUT       CLI$DISPATCH unable to invoke the routine. An
                       invalid routine is specified in the command
                       table, or no routine is specified.
Close Help