Next: , Previous: , Up: The Record Library   [Index]


13.5.5 Record Search Functions

All functions retrieving data link it if allowed, copy it otherwise.

r_first

integer r_first(record r, text &s);

is zero if the r record is empty, non zero otherwise. In the latter case s is set to the first position (first mapped key).

r_high

text r_high(record r);

is the last position (last mapped key)

r_last

integer r_last(record r, text &s);

is zero if the r record is empty, non zero otherwise. In the latter case s is set to the last position (last mapped key).

r_low

text r_low(record r);

is the first position (first mapped key)

rs_first

integer rs_first(&, record r, text &s);

is zero if the r record is empty, non zero otherwise. In the latter case s is set to the first position (first mapped key) and the first argument to its associated data.

rs_greater

integer rs_greater(&, record r, text a, text &s);

is zero if the r record defines no position (maps no key) after a, non zero otherwise. In the latter case s is set to the first position after a and the first argument to its associated data.

rs_last

integer rs_last(&, record r, text &s);

is zero if the r record is empty, non zero otherwise. In the latter case s is set to the last position (last mapped key) and the first argument to its associated data.

rs_less

integer rs_less(&, record r, text a, text &s);

is zero if the r record defines no position (maps no key) before a, non zero otherwise. In the latter case s is set to the last position before a and the first argument to its associated data.

rs_lower

integer rs_lower(&, record r, text a, text &s);

is zero if the r record defines no position (maps no key) less or equal to a, non zero otherwise. In the latter case s is set to the last not greater position and the first argument to its associated data.

rs_upper

integer rs_upper(&, record r, text a, text &s);

is zero if the r record defines no position (maps no key) greater or equal to a, non zero otherwise. In the latter case s is set to the first not less position and the first argument to its associated data.

rsd_greater

integer rsd_greater(&, record r, text a);

is zero if the r record defines no position (maps no key) after a, non zero otherwise. In the latter case the first argument is set to the data associated with the first after position.

rsd_less

integer rsd_less(&, record r, text a);

is zero if the r record defines no position (maps no key) before a, non zero otherwise. In the latter case the first argument is set to the data associated with the last before position.

rsd_lower

integer rsd_lower(&, record r, text a);

is zero if the r record defines no position (maps no key) less or equal to a, non zero otherwise. In the latter case the first argument is set to the data associated with the last not greater position.

rsd_upper

integer rsd_upper(&, record r, text a);

is zero if the r record defines no position (maps no key) greater or equal to a, non zero otherwise. In the latter case the first argument is set to the data associated with the first not less position.

rsk_greater

integer rsk_greater(record r, text a, text &s);

is zero if the r record defines no position (maps no key) after a, non zero otherwise. In the latter case s is set to the first position after a.

rsk_less

integer rsk_less(record r, text a, text &s);

is zero if the r record defines no position (maps no key) before a, non zero otherwise. In the latter case s is set to the last position before a.

rsk_lower

integer rsk_lower(record r, text a, text &s);

is zero if the r record defines no position (maps no key) matching or less than a, non zero otherwise. In the latter case s is set to the last position not after a.

rsk_upper

integer rsk_upper(record r, text a, text &s);

is zero if the r record defines no position (maps no key) matching or greater than a, non zero otherwise. In the latter case s is set to the first position not before a.


Next: Byte Data Record Search Functions, Previous: Non Data Type Specific Byte Data Record Functions, Up: The Record Library   [Index]