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

Retrieves the coordinate pairs of the current object in the object file.

Syntax

intl pipObjectGetCoords ( pipObjectFile obj_h, intl *points, intl maxPoints, intl *pointsPerPoly, intl maxPolygons, intl *nPolygons);

Arguments

obj_h The handle of the opened object file. Input.

*points Array in which to store the actual coordinates. Output. maxPoints Maximum number of points that the array can hold. Input.

*pointsPerPoly A list of the number of points in the polygon(s). Output.

maxPolygons Maximum number of polygons the pointsPerPoly array can hold. Input.

*nPolygons The total number of polygons. Output.

Return Value

PIP_OK PIP_ERROR

Prerequisites

pipObjectFindFirst*.

Alternates

None.

Notes

This function retrieves the list of coordinate pairs for the current object.

points This is an array that contains the actual coordinate (x,y) pairs. The points are returned as X1, Y1, X2, Y2, … Xn, Yn.
maxPoints The total number of points (x,y pairs) the array can hold.
pointsPerPoly This array contains the number of points in each polygon. Normally, there is only one entry in this array, unless a polygon object has islands or lakes associated with it.
maxPolys This is the number of entries the pointsPerPoly array can hold.
nPolygons The total number of polygons associated with this object. This is also the total number of actual entries in the pointsPerPoly array.