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

    The SMB$CHECK_FOR_MESSAGE routine determines whether a message
    sent from the job controller to the symbiont is waiting to be
    read.

    Format

      SMB$CHECK_FOR_MESSAGE

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. Condition values that this routine can
    return are listed under Condition Values Returned.

2 - Arguments

    None.

3 - Description

    When your symbiont calls the SMB$INITIALIZE routine to initialize
    the interface between the symbiont and the job controller, you
    can choose to have requests from the job controller delivered
    by means of an AST. If you choose not to use ASTs, your symbiont
    must call SMB$CHECK_FOR_MESSAGE during the processing of tasks in
    order to see if a message from the job controller is waiting to
    be read. If a message is waiting, SMB$CHECK_FOR_MESSAGE returns a
    success code; if not, it returns a zero.

    If a message is waiting, the symbiont should call SMB$READ_
    MESSAGE to read it to determine if immediate action should be
    taken (as in the case of STOP_TASK, RESET_STREAM or PAUSE_TASK).

    If a message is not waiting, SMB$CHECK_MESSAGE returns a zero.
    If this condition is detected, the symbiont should continue
    processing the request at hand.

4 - Condition Values Returned

    SS$_NORMAL         One or more messages waiting.
    0                  No messages waiting.