pipObjectFindNextEx - 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 next object for any pipObjectFindFirstPolygonEx function and calculates the percentage of the input region overlapped by the returned region in the object file.

Syntax

intl pipObjectFindNextEx ( pipObjectFile obj_h, pstr name- Buffer, intl bufSize, intl numIncrements, double* per- centage);

Arguments

obj_h The handle of the opened object file. Input.

nameBuffer A pointer to a buffer to be filled with the identifier of the object that is found. Output.

bufSize The size of the buffer that contains the identifier of the object that is found. If the buffer size is smaller than the identifier, the identifier is truncated. Input.

numIncrements Number of increments used in the overlap percentage calculation.

Input.

*percentage Calculated overlap percentage. Output.

Return Value

PIP_ERROR PIP_NOT_FOUND PIP_IN_POLYGON PIP_IN_BUFFER PIP_IN_BORDER PIP_OK PIP_REGION_OVERLAP PIP_OBJECT_IN_INPUT

PIP_OBJECT_EQUALS_INPUT

Prerequisites

pipObjectFindFirstPolygonEx.

Alternates

None.

Notes

If the number of increments is greater than 0 and the percentage is not NULL, this function computes the percentage of the input region overlapped by the region in the spatial file. The accuracy and precision of the calculation increases as the number of increments is increased. Note that increasing the number of increments also increases processing time.

If no additional objects are found, the function returns PIP_NOT_FOUND.