Daylight v4.9
Release Date: 1 February 2008

Name

dt_label2 - retrieve a string label

Generic Prototype

dt_label2(dt_Handle, dt_Handle) => dt_String

C Prototype

#include "dt_depict.h"

dt_String dt_label2(dt_Integer *len, dt_Handle depiction, dt_Handle object)

FORTRAN Prototype

include 'dt_f_depict.inc'

integer*4 dt_f_label2(depiction, object, string)

integer*4 depiction
integer*4 object
character*() string

Description

Gets the second string label associated with the given object 'object' in the depiction 'depiction'. String labels may be associated with any constituent of the underlying molecule, including the molecule itself.

Depending on the type of the object 'object', the label will be used in different ways. The first atom label is drawn to the lower left of the atomic symbol. The two bond labels are drawn above and below the bond. Cycle labels are unused. Molecule labels are drawn above and below the entire depiction.

Return Value

Returns the string label or the 'invalid string' if the object in the given depiction does not have a label2 defined.

Related Topics

dt_label1(3) dt_label1ga(3) dt_label2ga(3) dt_setlabel1(3) dt_setlabel2(3) dt_setlabel1ga(3) dt_setlabel2ga(3)