Returns data for all address and matched elements from GeoStan.
Syntax
GsFunStat GsDataGet(GsId gs, GsEnum fInOut, GsEnum fSwitch,pstr pbuffer, intsu
bufLen);
Arguments
GsIdgs ID returned by GsInitWithProps() for the current instance of GeoStan. Input.
GsEnumfInOut Flag indicating whether to retrieve original or processed data. Input.
To retrieve parsed address components, set fInOut to GS_INPUT. To retrieve matched address information from the parsed input address and the GeoStan database, set fInOut to GS_OUTPUT.
If the input address does not match, setting fInOut to GS_OUTPUT returns the address exactly as entered, except for the lastline information, which returns only the parsed lastline components.
The parsed lastline components correspond to the following enums:
|
GS_LASTLINE |
GS_ZIP4 |
|
GS_CITY |
GS_ZIP9 |
|
GS_STATE |
GS_ZIP10 |
|
GS_ZIP |
If there is extra data on the input lastline (GS_LASTLINE), this data is not retrievable. For example, in the lastline "BOULDER CO 80301 US OF A", "US OF A" is not retrievable from any GsDataGet() call.
To retrieve centerline return values, setting fInOut to GS_CENTERLINE returns a collection of ranged segments for streets that contain addresses. Individual addresses may be interpolated from the low-high ranges of the segments.
GsEnumfSwitch: Symbolic constant for the data item to retrieve. Input.
pstrpbuffer: Location to store the returned data. Output.
intsubufLen: Maximum size of data for GeoStan to return. geostan.h lists as constants the recommended buffer sizes for each item. These sizes include the null terminator and are the maximum lengths required to get the full output string. You can allocate a buffer that is smaller or larger than these values. However, if bufLen is shorter than the returned data, GeoStan truncates the data and does not generate an error. Input.
Return Values
GS_SUCCESS
GS_ERROR
Prerequisites
GsFindWithProps()
Notes
This function retrieves data elements from internal GeoStan buffers for either the original (input) or matched (output) data elements. To retrieve original data, set fInOut to GS_INPUT. To retrieve matched data, set fInOut to GS_OUTPUT.
If your GeoStan license has metering enabled, using GsDataGet() to return a geocode increments the counter unless the match code indicates an error or a 5-digit ZIP geocode.