pipObjectFindFirstPolygon - 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 polygon in the object file overlapping the input

POLYGON.

Syntax

intl pipObjectFindFirstPolygon ( pipObjectFile obj_h, intl *points, intl

*numPointsPerPoly, intl numPolygons, pstr nameBuffer, intl bufSize );

Arguments

obj_h File handle from pipObjectFileOpen. Input.

*points Input region; an array of x,y point values. Input.

*numPointsPerPoly Array of point counts for each polygon in the region. Input. numPolygons Number of polygons in input region. Input.

nameBuffer A pointer to a buffer to be filled with the identifier of the object from the object file which the input polygon overlaps. Output.

bufSize The size of the buffer that contains the identifier of the object which the input polygon overlaps. If the buffer size is smaller than the identifier, the identifier is truncated. Input.

Return Value

PIP_ERROR PIP_NOT_FOUND PIP_REGION_OVERLAP PIP_INPUT_IN_OBJECT PIP_OBJECT_IN_INPUT PIP_OBJECT_EQUALS_INPUT

Prerequisites

pipObjectFileOpen.

Alternates

pipObjectFindFirstPolygonEx, pipCheckForRegionOverlap.

Notes

This function compares an input polygon with polygons in an existing object file. If any region in the object file intersects with the input region, the intersection type is returned. If no overlapping region is found, the function returns PIP_NOT_FOUND.