dt_mer_hit2id

Daylight v4.9
Release Date: 1 February 2008

Name

dt_mer_hit2id - convert a hitlist index to a row identifier

Generic Prototype

dt_mer_hit2id(dt_Handle, dt_Integer) => dt_Integer

C Prototype

#include "dt_merlin.h"

dt_Integer dt_mer_hit2id(dt_Handle hitlist, dt_Integer item)

FORTRAN Prototype

include 'dt_f_merlin.inc'

integer*4 dt_f_mer_hit2id(hitlist, item)

integer*4 hitlist
integer*4 item

Description

Converts a row's hitlist index 'item' to its id. An id is an arbitrary but unique integer that identifies a particular row in a hitlist. You can ask for the id of a row in one hitlist, then use its id to find the row's position (hitlist index) in another hitlist or in a modified version of the original hitlist. An id has no other use.

An id is guaranteed to be unique and invariant over the life of a pool. No other assumptions should be made about the properties of an id.

Return Value