GsMultipleGetHandle - geostan_1 - 2024.01

GeoStan Geocoding Suite Reference for Windows, Linux, and z/OS

Product type
Software
Portfolio
Locate
Product family
GeoStan Geocoding Suite
Product
GeoStan Geocoding Suite > GeoStan
Version
2024.01
Language
English
Product name
GeoStan
Title
GeoStan Geocoding Suite Reference for Windows, Linux, and z/OS
Copyright
2024
First publish date
1994
Last updated
2024-07-29
Published on
2024-07-29T23:01:18.924000

Returns the range handle for the match candidate specified.

Syntax

GsFunStat GsMultipleGetHandle(GsId gs,ints index,GsRangeHandle *pHandle);

Arguments

GsIdgs   ID returned by GsInitWithProps() for the current instance of GeoStan. Input.

intsindex   Entry number (0-based) of the possible match. Input.

GsRangeHandle *pHandle   Range handle for the possible match entry. Output.

Return Values

GS_SUCCESS

GS_ERROR

Prerequisites

GsNumMultiple()

Notes

This function can extract additional information about a possible match than GsMultipleGet(). It retrieves the range handle for the possible match indicated by the entry argument. Once you have the correct range handle, you can retrieve information by using GsHandleGet().

For a list of elements returned by GsMultipleGet() or GsHandleGet(), see Enums for storing and retrieving data.