Populates the supplied buffer with the information about the item being queried for the specified database.
Syntax
ints GsGetDBMetadata(GsId gs, int WhichItem, int WhichDB,
pstr buffer, int bufSize);
Arguments
gs ID returned by GsInitWithProps() for the current instance of GeoStan. Input.
WhichItem Specific information to return. The following table includes types of available information. Input.
|
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. See GS_FIND_CLIENT_CRS for further information on setting the NAD for geocoding. Returns GS_SUCCESS or GS_ERROR. The retrieved information is placed in the buffer. |
|
GS_STATUS_DB_COPYRIGHT |
Returns copyright information for User Dictionary. |
|
GS_STATUS_DB_COUNTRY |
Returns country associated with User Dictionary. |
|
GS_STATUS_DB_FILE_PATH |
Returns filesystem path to the User Dictionary. |
|
GS_STATUS_DB_VERSION |
Returns version string for the User Dictionary. |
WhichDB A database index, starting at 0 and less than the number of databases returned by GsGetNumDB(). Input.
buffer Location to store the returned data. Output.
bufSize Maximum size of data for GeoStan to return. Geostan.h lists as constraints 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 bufSize is shorter than the returned data, GeoStan truncates the data and does not generate an error. Input.
Return Values
GS_ERROR
GS_SUCCESS
Prerequisites
GsInitWithProps()