Daylight v4.9
Release Date: 1 February 2008

Name

dt_mer_getroot - retrieve the root identifier of a hitlist item

Generic Prototype

dt_mer_getroot(dt_Handle, dt_Integer) => dt_String

C Prototype

#include "dt_merlin.h"

dt_String dt_mer_getroot(dt_Integer *len, dt_Handle hitlist, dt_Integer item)

FORTRAN Prototype

include 'dt_f_merlin.inc'

integer*4 dt_f_mer_getroot(hitlist, item, string)

integer*4 hitlist
integer*4 item
character*() string

Description

Gets the root identifier of a particular hit. The only way to save a hit list externally is to save all of the root identifiers of the hits.

Return Value

Returns the root identifier of a hit as a TDT string containing only the root identifier's tag and the identifier (eg. "$TAG<ID>|"). The root identifier is defined as the 'invalid string' for all other object types.

Related Topics

dt_mer_alloc_hitlist(3) dt_mer_clear(3) dt_mer_combinehitlists(3) dt_mer_hit2id(3) dt_mer_id2hit(3) dt_mer_invert(3) dt_mer_length(3) dt_mer_mvbottom(3) dt_mer_mvtop(3) dt_mer_native(3) dt_mer_reset(3) dt_mer_reverse(3) dt_mer_sethits(3) dt_mer_zapabove(3) dt_mer_zapbelow(3) dt_mer_zapna(3) dt_mer_zapnonunique(3)