Prepares GSX files needed to cover the finance area.
Syntax
GsFunStat GsPrepareIndexFinance(GsId gs,long finance,const char
*outDir,
void *progressData,spatialQueryProgress
progress);
Arguments
GsIdgs ID returned by GsInitWithProps() for the current instance of GeoStan. Input.
longfinance Finance area to index. In the format ssffff, where s=state and f=finance. Input.
const charoutDir Directory to write .gsx files. Input.
void*progressData Data to pass to progress. Input.
spatialQueryProgressprogress Callback function for progress meter. If NULL GeoStan does not call progress. Input.
Return Values
GS_SUCCESS
GS_ERROR
GS_CANCEL Progress function had a cancel request from the user.
GS_NOT_FOUND More than 6 digits were entered for the finance parameter.
Prerequisites
GsCityDataGet()
Notes
Prepares the reverse geocoding system for searching the requested finance area, unlike PrepareIndexMbr(), which prepares the system for each finance area included partially or wholly within the area bounded by the four input points. See PrepareIndexMbr for more information.
Call before GsFindFirstSegmentByMbr().
This function expects that you have either installed the prebuilt GSX file that ships on the data media or that you have already created the GSX file using the batchind.exe utility included with GeoStan.
For more information, referGeoStan Geocoding Suite Utilities Reference.
For proper execution, initialize GeoStan with a call to GsInitWithProps() and include at least the following properties set to TRUE:
GS_INIT_OPTIONS_ADDR_CODE
GS_INIT_OPTIONS_SPATIAL_QUERY
GS_INIT_OPTIONS_Z9_CODE
In addition, when using GsInitWithProps() include the outDir directory in the search path. For example, C:\data;C:\gsxout, where C:\data contains the primary data files and C:\gsxout is the output directory for GSX files. Include finmbr.dat in the GsInitWithProps() search path when creating GSX files.
See GsPrepareIndexMbr for more information on the progress function.