The format for the syntax of each function is:
ReturnType FunctionName (ArgumentType identifier, ArgumentType
identifier )
where:
- ReturnType is the type of Return value associated with the function.
- FunctionName is the name of the function.
- ArgumentType is the type of the identifier that follows.
- identifier is the descriptive name of the argument.
intl | signed integer |
pintl | pointer to signed integer |
pipExporter | unsigned integer |
pipHandle | unsigned integer |
pipImporter | unsigned integer |
pipObjectFile | unsigned integer |
pipObjectFileInfoStruct | structure |
pipObjectInfoStruct | structure |
pipOverlapHandle | unsigned integer |
pipRadial | unsigned integer |
pipZip4File | unsigned integer |
pstr | pointer to null terminated string |
All examples in the function reference using C.
Return Value Explanations
The following table lists the library function return values and their explanations.
1 - 99 | Standard C library error values. |
109-199 | Reserved for future use. |
PIP_ERROR | Function failed; use pipErrorGet to get details. |
PIP_ERROR_ARGUMENT | Invalid arguments to function. |
PIP_ERROR_BAD_FILE | File has incorrect signature. |
PIP_ERROR_EXPIRED | File is out of date. |
PIP_ERROR_INVALID_HANDLE | Invalid handle returned from pipInit. |
PIP_ERROR_LICENSE | License file is missing, Spatial+ not licensed, or bad password. |
PIP_ERROR_LIMIT | Internal table overflow. |
PIP_ERROR_MEMORY | Insufficient memory. |
PIP_ERROR_NOT_FOUND | File not found. |
PIP_ERROR_UNCLASSED | Unclassed error. |
PIP_ERROR_UNKNOWN | Unknown error. |
PIP_IN_BORDER | The point is inside the polygon, and the associated buffer. This can only occur for a polygon, and not line or point feature. |
PIP_IN_BUFFER | A buffer area, but not a polygon, that contained the point. |
PIP_IN_POLYGON | A polygon that contained the point. |
PIP_INPUT_IN_OBJECT | Input region is inside the object file region object. |
PIP_NO_REGION_OVERLAP | Regions don't overlap. |
PIP_NOT_FOUND | Object not found. |
PIP_OBJECT_EQUALS_INPUT | The object file region equals the input region. |
PIP_OBJECT_EQUALS_OUTPUT | The object file region equals the output region. |
PIP_OBJECT_IN_INPUT | Object file region object is inside the input region. |
PIP_OK | Function successful. |
PIP_READ_STORED | Object was read and stored. |
PIP_READ_WRONG_TYPE | Object wasn't a point, line, or polygon and wasn't stored. |
PIP_REGION_A_EQUALS_B | The regions are same. |
PIP_REGION_A_IN_B | Region A is wholly encompassed by Region B. |
PIP_REGION_B_IN_A | Region B is wholly encompassed by Region A. |
PIP_REGION_OVERLAP | The two regions overlap but the intersection area doesn't equal either region. |
Using the Spatial+ Library in Windows
When using Spatial+ on Windows, be sure to define the _WINDOWS symbol. Your project must define one or both of the following:
NT
or/and _WIN32
You are not warned with compile or link errors if you fail to define these symbols; however, your application will not function properly and can result in insufficient stack space.
Microsoft compilers typically define these symbols for you, but Precisely strongly recommends that you define them in your project for completeness
When using Spatial+ in UNIX, be sure the following symbol is defined:
_unix
(or) _UNIX
About the cc Compiler
Many UNIX and Linux systems have a "cc" compiler for use in system configuration. This compiler is provided because many UNIX system kernels require compilation of device drivers to make system changes. The "cc" compiler is not intended to be a robust or complete development system. Spatial+ performs best using the UNIX optimizing compiler option. Precisely recommends that UNIX developers contact their UNIX vendor and purchase the optimizing compiler option before using Spatial+.
Precisely libraries require certain standard libraries which are available on every UNIX development platform, but may not be found unless the appropriate system option has been installed.1 For more information on compiling and linking C programs with object dependencies, see Using Spatial+ with UNIX.
1 Some systems may include these libraries as part of a development option, or with an additional package such as the optimizing compiler. Contact your OS vendor for more information about the standard libraries. |