GsErrorGetEx - 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 GeoStan informational, error, and fatal warning information for the current thread.

Syntax

void GsErrorGetEx(GsID id, pstr error_message, pstr details)

Arguments

GsIDid   GsId returned by GsInitWithProps() if initialization completed, or set to NULL if initialization failed and GsInitWithProps() returned NULL.

pstrerror_message    GeoStan error code and descriptive text. The error_message has the following format: SGTppeeeDESCRIPTION, where:

nSGT is a constant value.

npp is the product number (01 for GeoStan).

neee is the three character error code.

nDESCRIPTION is a short text message naming the error.

pstrdetails   Descriptive message, such as the file name associated with the error.

Return values

The next GeoStan error detected in the current thread. Upon return, error messages contain a brief description and additional text, such as the name of the file or directory associated with the error.

Note: Not all errors are fatal. For example, if GeoStan finds an invalid data file, it reports the error but continues executing.

Prerequisites

GsInitWithProps()

GsErrorHas()

Example

See GsInit_r for example code.