GsHandleGet - 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

Retrieves data for objects found via GsFindFirst() and GsFindNext().

Syntax

GsFunStat GsHandleGet(GsId gs, GsEnum fSwitch,GsRangeHandle *pRange, pstr pBuffer,intsu bufLen);

Arguments

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

Note: See Enums for storing and retrieving data for a list of valid enums and maximum sizes.

fSwitch   Enum for the argument you want to retrieve. Input.

*pRange   Pointer to the current range handle. Input.

pBuffer   Location to store the returned data. Output.

bufLen   Maximum size of the data that GeoStan returns. If bufLen is shorter than the data returned by GeoStan, GeoStan truncates the data and does not generate an error. Input.

Return Values

GS_SUCCESS

GS_ERROR

Prerequisites

GsFindFirst() or GsFindNext()

Notes

This function retrieves data from the geocode buffer for a given range handle. If you have a street or segment handle, you must convert the handle to a range handle before you can use this function.

See Extracting Data from GSD Files for more information on the Find First and Find Next searches. For information on extracting Alias information, refer to the description in GsMultipleGet().