pipErrorGet - spatial_geostan - 2024.00

Spatial+ Reference for Windows, UNIX/Linux, z/OS

Product type
Software
Portfolio
Locate
Product family
GeoStan Geocoding Suite
Product
GeoStan Geocoding Suite > Spatial+
Version
2024.00
Language
English
Product name
Spatial+
Title
Spatial+ Reference for Windows, UNIX/Linux, z/OS
Copyright
2024
First publish date
1994
Last updated
2024-05-07
Published on
2024-05-07T22:16:04.316305

Returns details about the most recent error or message.

Syntax

intl pipErrorGet ( pipHandle h, pstr errMsg, pstr errDetail );

Arguments

h

The valid handle returned by pipInit for the current instance of Spatial+. Input.

errMsg

A pointer to a string buffer where the message is placed. Output.

errDetail

A pointer to a string buffer where details about the message are placed. Output.

Return Value

1 - 99

PIP_ERROR_UNCLASSED

PIP_ERROR_INVALID_HANDLE

PIP_ERROR_UNKNOWN

PIP_ERROR_BAD_FILE

PIP_ERROR_LIMIT

PIP_ERROR_MEMORY

PIP_ERROR_NOT_FOUND

PIP_ERROR_ARGUMENT

PIP_ERROR_EXPIRED

PIP_ERROR_LICENSE

109-199

Prerequisites

None.

Alternates

None.

Notes

Be sure to allocate string space of at least 256 bytes for both errMsg and errDetail.

Example

/*The example retrieves the last error info */
char errMsg[256]; char errDetail[256];
if(ret_val == PIP_ERROR)
 {
  pipErrorGet(h, errMsg, errDetail);
  printf("An error has occurred: %s, %s", errMsg, errDetail);
   return 1;
 }