Daylight v4.9
Release Date: 1 February 2008

Name

dt_uidrange - find the maximum 'unique ID' in an object

Generic Prototype

dt_uidrange(dt_Handle, dt_Integer) => dt_Integer

C Prototype

#include "dt_smiles.h"

dt_Integer dt_uidrange(dt_Handle object, dt_Integer type)

FORTRAN Prototype

include 'dt_f_smiles.inc'

integer*4 dt_f_uidrange(object, type)

integer*4 object
integer*4 type

Description

Finds the highest uid for the object within its containing (parent) object and type, and returns an integer at least 1 greater than it.

Uids are intended to be small, dense integers. For this reason, uids make good array indices (where handles do not). The uidrange value is typically used as a loop counter over an array of indices.

Return Value

Returns the integer uid. For objects not defined to have a uid (see dt_uid(3)) this property is defined as -1.

Related Topics

dt_uid(3)