pipObjectFileQuery - 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

Gets header information from a Spatial+ object file.

Syntax

intl pipObjectFileQuery ( pipHandle h, pstr fileName, pipObjectFileInfoStruct

*pFileInfo );

Arguments

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

fileName The complete path and filename of a Spatial+ object file to open.

Input.

*pFileInfo The pointer to a structure to be filled with the header information.

Output.

Return Value

PIP_OK PIP_ERROR

pipInit.

Prerequisites

Alternates

None.

Notes

Fills the structure pipObjectFileInfoStruct with the file description information. The structure is as follows:

Parameter Explanation
char userData[256] Data set by user-determined string.
intl maxHeapSize Size of largest object (without buffer information).
intl maxPointCount Number of points in largest object. Max points = 55000000.
intl maxPolygonCount Maximum number of polygons in a single object. Max polygons = 16383.
intl xmin, ymin, xmax, ymax Geographic extent of the file.
intl coordSys

This parameter is used to indicate which type of coordinates the points and responses will be given in. There are two possible settings:

PIP_COORDS_USER—Coordinates are user defined, and Euclidean distances are returned in user units.

PIP_COORDS_LL—Coordinates are in millionths of degrees, and distances are returned in feet.

intl flags

This is any combination of the following flags added together: PIP_IMPORT_BUFFERS creates buffer

information in the file (and roughly triples

the file's size).

PIP_IMPORT_COMPRESS stores compressed information, but significantly slows processing speed. This parameter is recommended when batch speed is not an issue, such as in a real-time, interactive application.

intl numPoints Number of point objects in the file.
intl numLines Number of line objects in the file.
intl numRegions Number of region objects in the file.
intl reserved[5] Reserved for future use.