Get Location Index Properties

 

Summary

Gets the properties of a Location index.

 

Syntax

property_array = RunMacro("GISDK Get Location Index Properties", string index_file)

 

Argument	Contents
index_file	The file name of the Location index

 

Return Value

An array of key/value pairs (an options array) that describe the content of the Location index stored in the file, and can be used as an input argument to the Get Location Index macro.

 

Notes

• In Caliper Script, you must set the Geocode UI to be the alternate interface by calling SetAlternateInterface("geocode") before running this macro. When calling these macros from VBScript, add "geocode" after the macro name and before the first argument.

• The index_file argument must either be a full pathname (e.g., "c:\\data\\myindex.idx") or a pathname relative to the Maptitude program folder (e.g., "myfiles\\myindex.idx")

Example

// Before running this example, and make sure that the Location index

// HARTFORD.IDX exists in the Tutorial folder.

folder = RunMacro("G30 Tutorial Folder")

index_file = folder + "hartford.idx"

SetAlternateInterface("geocode")

index_properties = RunMacro("GISDK Get Location Index Properties", index_file)

ShowArray(index_properties)