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

Finds first ZIP + 4 in any object in the object file.

Syntax

intl pipZip4FindFirst ( pipZip4File zip_h, pipObjectFile obj_h, intl radius, pstr zip9, pstr code, pstr name,

intl nameSize );

Arguments

zip_h The handle of the opened ZIP + 4 Z9 file. Input.

obj_h The handle of the opened object file to search. Objects must be defined in millionths of degrees. Input.

radius The buffer radius, if any, to apply to the features in the object file. If this value is non zero, the object file must have been built with buffering enabled. Input.

zip9 A pointer to a string containing the first 9-digit ZIP Code found in any polygon or zone around a line or point, in the object file.

Output.

code The centroid type code. (See , "Location Codes".) Output. name A pointer to a string to be filled with the identifier of the first

object in which the ZIP + 4 is located. Output.

nameSize The size of the buffer that contains the identifier of the first object in which ZIP + 4 is located. If the buffer size is smaller than the identifier, the identifier is truncated. Input.

Return Value

PIP_OK PIP_ERROR PIP_NOT_FOUND

Prerequisites

pipZip4FileOpen, pipObjectFileOpen.

Alternates

None.

Notes

This function returns the first ZIP + 4 found inside any of the objects or buffered lines or points in the object file.

The zip9 parameter must point to a buffer of at least 10 bytes. The code parameter must point to a buffer of at least 2 bytes. If no ZIP + 4 is found, the function returns PIP_NOT_FOUND.