Daylight v4.9
Release Date: 1 February 2008


dt_atstart - test if a compound object iteration is at its start

Generic Prototype

dt_atstart(dt_Handle) => dt_Boolean

C Prototype

#include "dt_smiles.h"

dt_Boolean dt_atstart(dt_Handle object)

FORTRAN Prototype

include ''

logical dt_f_atstart(object)

integer*4 object


Determines if the sequence, is at its start.

Return Value

Returns TRUE if the sequence has been reset. If TRUE, a call to dt_next(3) would return the first object in the sequence. Returns FALSE if the sequence has not been reset or if 'object' is not a sequence.

Related Topics

dt_alloc_seq(3) dt_atend(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)