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

Computes the distance from a point to the border of the current object.

Syntax

intl pipObjectDistanceToBorder ( pipObjectFile obj_h, intl lon, intl lat );

Arguments

obj_h The handle of the object file from pipObjectFileOpen. Input. lon The longitude (in millionths of degrees) or x coordinate defining

the input point. Input.

lat The latitude (in millionths of degrees) or y coordinate defining the input point. Input.

Return Value

Returns distance to nearest edge on border if successful. If PIP_ERROR, use pipErrorGet for more information.

Prerequisites

pipObjectFindFirstContaining or pipObjectFindFirstName.

Alternates

None.

Notes

This function computes the distance from a point to the border of a region, line, or point object.

This function is only defined for buffered spatial object files (of file type .gsb).

Before this function can be called, an object needs to be selected as the "current object." This can be done with any of the pipObjectFind_ or pipRadFind_ functions. For example, pipObjectFindFirstNearest (for Point objects), pipObjectFindFirstContaining, pipRadFindFirstInRadius, or pipObjectFindNext could be used.