LSE$CLIHELP.HLB  —  SCA Topics, Callable Routines, SCA$QUERY_GET_OCCURRENCE
    Gets the next occurrence in the query result that is specified as
    a query_context argument.

    Format

      SCA$QUERY_GET_OCCURRENCE  query_context,

                                entity_handle

1  –  Arguments

 query_context
    type:       $SCA_QUERY_CONTEXT
    access:     read/write
    mechanism:  by reference

    An SCA query context whose occurrences are to be obtained.

 entity_handle
    type:       $SCA_HANDLE
    access:     read/write
    mechanism:  by reference

    An SCA entity handle that describes an entity.

2  –  Condition Values Returned

    SCA$_NORMAL           An occurrence has been successfully
                          returned.

    SCA$_NEWSYMBOL        An occurrence has been successfully
                          returned. This new occurrence is of a
                          different symbol than the occurrence that
                          was returned by the previous call to this
                          routine.

    SCA$_NOMORE           Warning. An occurrence has not been
                          returned. The traversal of the query result
                          has been exhausted.

3  –  Description

    The SCA$QUERY_GET_OCCURRENCE routine successively returns every
    occurrence in a query result. It provides one pass through all of
    the occurrences.

    This routine will become obsolete in a future version of SCA. The
    SCA$GET_OCCURRENCE routine supersedes this routine.
Close Help