Maptitude GISDK Help

GetFirstRecord()

Summary

Finds the first record in a view or selection set based on a sort order.

 

Syntax

record_handle = GetFirstRecord(string view_set, array sort_order)

 

Argument

Contents

view_set

The view and the set of records to consider

sort_order

An array that indicates the desired sort order, or null for natural order. The array is an array of field name-order pairs:

 

Element

Type

Contents

1

String

The name of the field

2

String

"Ascending" or "Descending"

 

Returns

The record handle (string) for the first record in the input view and set when sorted as specified, or null if the input view and set has no records.

 

Notes

Example

first_emp = GetFirstRecord("Employees|", {{"LNAME", "Ascending"}})

first_emp = GetFirstRecord("Employees|", {

     {"LNAME", "Ascending"},

     {"FNAME", "Ascending"}

     })

 

Error Codes

Error Type

Meaning

NotFound

The specified view or set does not exist; or

some field in the sort_order array does not exist

 

See Also

Function

Summary

GetLastRecord()

Gets the last record in a view or selection set based on a sort order

GetNextRecord()

Gets the next record in a view or selection set based on a sort order

GetPrevRecord()

Finds the previous record in a view or selection set based on a sort order

GetRecord()

Gets the record handle of the current record of a view

GetRecords()

Gets an array of record handles for a selection set

LocateRecord()

Locates a record based on the value of a field

SetRecord()

Sets the current record of a view

 

 

©2025 Caliper Corporation www.caliper.com