Daylight v4.9
Release Date: 1 February 2008


dt_atend - test if a compound object iteration is at its end

Generic Prototype

dt_atend(dt_Handle) => dt_Boolean

C Prototype

#include "dt_smiles.h"

dt_Boolean dt_atend(dt_Handle object)

FORTRAN Prototype

include ''

logical dt_f_atend(object)

integer*4 object


Determines if the sequence or stream has advanced to its end.

Return Value

Returns TRUE if the most recent call to dt_next(3) returned NULL_OB because the end of the stream or sequence was reached.

Returns FALSE if dt_next(3) has not been called for the sequence or stream, or has not been called since the last dt_reset(3) for the object (even if the stream or sequence is empty). Note that if the most recent call to dt_next(3) returned something other than NULL_OB, dt_atend(3) will return FALSE.

Related Topics

dt_alloc_seq(3) dt_atstart(3) dt_count(3) dt_next(3) dt_reset(3) dt_append(3) dt_delete(3) dt_insert(3) dt_seqsort(3) dt_stream(3) dt_toend(3)