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

Cleans up and deletes the pipExporter resources, and determines whether the export file is to be kept or discarded. Terminates the export subsystem.

Syntax

intl pipExportTerm ( pipExporter exp_h, intl completed );

Arguments

exp_h

The handle returned by pipExportInitBNA , pipExportInitMIF , pipExportInitShape , or pipExportInitTab for the current export process. Input.

completed

Flag indicating if the output BNA, MIF/MID, SHP, or TAB file should be kept or discarded. Set to TRUE if the file should be kept. Set to FALSE if the file should be discarded. Input.

Return Value

PIP_OK

PIP_ERROR

Prerequisites

pipExportWrite and pipExportInsert

Alternates

None

Notes

This is the last function called in the export process.

Warning: Be sure to use the pipExporter handle and not the Spatial+ pipHandle type.

If pipExportWrite or pipExportInsert generates a PIP_ERROR before %=100, or any other error occurs so that writing to the export file can not continue, set COMPLETED=FALSE. This discards the export file.

If the creation of the export file did not fail, set COMPLETED=TRUE. The export file is saved.

Regardless of how the completed parameter is set, all system resources used during export will be freed.

Example

See pipExportInitMIF