Returns information about the current GeoStan data set and license.
Syntax
intlu GsFileStatusEx(GsId gs, int mode, pstr buffer, int bufSize);
Arguments
GsIdgs ID returned by GsInitWithProps for the current instance of GeoStan. Input.
intmode Specific information to return. The following table includes the types of information available. Input.
See the Return Values section for information on the data types and datum returned.
|
Mode |
Data Returned |
|---|---|
|
GS_STATUS_DATATYPE_NUM |
Returns a numeric constant representing the data type. |
|
GS_STATUS_DATATYPE_STR |
Returns GS_SUCCESS or GS_ERROR. GeoStan places this retrieved information in the buffer. |
|
GS_STATUS_DATUM_NUM |
Returns a numeric constant representing the datum. |
|
GS_STATUS_DATUM_STR |
This is the NAD used natively by the data. It does not reflect the datum currently in use by GeoStan. You can use the Find property, GS_FIND_CLIENT_CRS, to set the returned NAD. Returns GS_SUCCESS or GS_ERROR. The retrieved information is placed in the buffer. |
|
GS_STATUS_DAYS_REMAINING |
•For unmetered licenses and metered unlimited licenses, it returns DAYS_UNLIMITED or the number of days remaining before the expiration of the license. •For metered limited licenses, it returns the days remaining before license expiration. |
|
GS_STATUS_FILE_CHKSUM_NUM |
Returns a calculated value (an integer) used to check data integrity. Set the buffer and bufsize parameters to 0; they are unused. |
|
GS_STATUS_GEO_PRECISION |
Returns the number of decimal places of longitude/latitude stored in the GSD file. Default is 4. Point-level data is 6. |
|
GS_STATUS_GEO_RECORD_TOTAL |
•For unmetered licenses, it returns 0. •For metered licenses, it returns the total number of records geocoded. |
|
GS_STATUS_RECORDS_REMAINING |
•For unmetered licenses and metered licenses it returns RECORDS_UNLIMITED. •For metered limited licenses, it returns the number of records remaining on the license. Use GS_STATUS_DAYS_REMAINING, GS_STATUS_RECORDS_REMAINING, or GS_STATUS_GEO_RECORD_TOTAL to request information on the status of the GeoStan license. |
pstrbuffer Location to store the returned data. Output.
intbufSize Maximum size of data that GeoStan returns. If bufSize is shorter than the data returned by GeoStan, GeoStan truncates the data and does not generate an error. Input.
Return Values
This function returns a variety of information about the current GeoStan data set.
|
GS_STATUS_DATATYPE_X |
Lists the data vendor |
|
GS_STATUS_DATUM_X |
Returns the datum used to identify geographic coordinates. |
|
GS_STATUS_RECORDS_REMAINING, GS_STATUS_DAYS_REMAINING, GS_STATUS_GEO_RECORD_TOTAL |
Return license usage information. |
You can use the preceding arguments to determine the status of your GeoStan license, as shown in the GsInitWithProps() code example.
The following table shows the return values for GS_STATUS_DATATYPE_NUM.
|
GS_STATUS_DATATYPE_NUM |
Data Type |
|---|---|
|
0 |
USPS |
|
1 |
TIGER |
|
2 |
TomTom street-level data |
|
4 |
Deprecated |
|
6 |
HERE (formerly NAVTEQ) street-level data |
|
7 |
TomTom point-level data |
|
9 |
Auxiliary file |
|
10 |
User Dictionary |
|
11 |
HERE (formerly NAVTEQ) point-level data |
|
12 |
Master Location Data |
The following table shows the return values for GS_STATUS_DATATYPE_STR.
|
GS_STATUS_DATATYPE_STR |
Data Type |
|---|---|
|
USPS |
USPS |
|
TIGER |
TIGER |
|
TOMTOM |
TomTom street-level data |
|
HERE |
HERE street-level data |
|
TOMTOM POINT DATA |
TomTom point-level data |
|
AUXILIARY |
Auxiliary file |
|
USER DICTIONARY |
User Dictionary |
|
HERE POINT DATA |
HERE point-level data |
|
MASTER LOCATION |
Master Location Data |
The following table shows the return values for GS_STATUS_DATUM_STR.
|
GS_STATUS_DATUM_STR |
Data Type |
|---|---|
|
0 |
NAD27 |
|
1 |
NAD83 (WGS84 for TomTom data) |
Prerequisites
GsInitWithProps()