pipRadFindFirstInRect - 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 the first point in a rectangle.

Syntax

intl pipRadFindFirstInRect ( pipRadial rad_h, intl xmin, intl ymin, intl xmax, intl ymax, intl *x, intl *y, pstr name, intl nameSize );

Arguments

rad_h The handle returned by pipRadInit for the current radial analysis. Input.

xmin, ymin These two parameters describe the lower left point of the rectangle to search in. Input.

xmax, ymax These two parameters describe the upper right point of the rectangle to search in. Input.

*x A pointer to the x coordinate or longitude of the located point.

Output.

*y A pointer to the y coordinate or latitude of the located point.

Output.

name A pointer to a buffer to be filled with the name of the located point.

Output.

nameSize The size, in bytes, of the name of the located point. Input.

Return Value

PIP_OK PIP_NOT_FOUND PIP_ERROR

Prerequisites

pipRadInsertPoint or pipRadLoadPoints.

Alternates

None.

Notes

This function returns the first point found in the radial search tree that falls within the rectangle described by xmin, ymin, xmax, ymax. This point may be anywhere in or on the rectangle. Points are returned in no particular order.

If no point is found within a given rectangle, the function returns PIP_NOT_FOUND.