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

Retrieves additional meta data in the GSB file.

Syntax

intl pipObjectHandleFileQueryEx ( pipObjectFile h, pipObjectFileExtraInfoStruct

*headerData );

Arguments

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

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

Output.

Return Value

PIP_OK PIP_ERROR

Prerequisites

pipObjectFileOpen

Alternates

None.

Notes

The pipObjectHandle FileQueryEx function uses pipObjectFileExtraInfoStruct as a data structure to hold extended information about a file.

Example

The pipImportInitEx function adds the file information listed below and the pipObjectFileExtraInfoStruct is populated as shown below after calling this function:

Field Description
char source[256] User-defined source of this data.
char version[32] User-defined version of this data.
char dateCreated[32] Date string when the GSB was created.
intl gsbVersion Current GSB version.
intl datum Datum of user data; either DATUM_NAD27 or DATUM NAD83.