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

During import, reads and writes into the object files the next object from a BNA, MIF/MID, SHP, or TAB file.

Syntax

intl pipImportRead ( pipImporter imp_h, pstr name, intl nameSize, pintl

percent, pintl lineNumber );

Arguments

imp_h The handle returned by pipImportInit for the current import process. Input.

name A pointer to a buffer to be filled with the feature identifier. Output. nameSize The maximum size of the identifier to store. Input.

percent The percent of the import file read so far. Output. lineNumber The number of lines in the import file read so far. Output.

Return Value

PIP_NOT_FOUND PIP_ERROR PIP_READ_STORED PIP_READ_WRONG_TYPE

Prerequisites

pipImportOpenBNA, pipImportOpenMIF2, pipImportOpenShape, or

pipImportOpenTab.

Alternates

None.

Notes

If you receive PIP_ERROR, you should abort the import by calling pipImportClose, then

pipImportTerm with FALSE as the completed parameter.

Be sure to use pipImporter handle and not the Spatial+ pipHandle type. This function reads the next feature from the current import file.

The name, percent, and lineNumber parameters are provided for the developer's use to facilitate building a "percent complete" meter or to provide meaningful diagnostic messages.

If you have reached the end of a file, the function returns PIP_NOT_FOUND.

Example

See pipImportInit.