gdlNearDistance - geographicdeterminationlibrary - 2024.00

Geographic Determination Library Reference for Windows and z/OS

Product type
Software
Portfolio
Locate
Product family
GeoStan Geocoding Suite
Product
GeoStan Geocoding Suite > Geographic Determination Library
Version
2024.00
Language
English
Product name
GeoStan Geocoding Suite
Title
Geographic Determination Library Reference for Windows and z/OS
Topic type
Reference
Copyright
2024
First publish date
1994
ft:lastEdition
2024-05-09
ft:lastPublication
2024-05-09T00:55:21.277227

Determines the minimum distance that exists between an error surface and any other feature: point or line.

Syntax

intl gdlNearDistance( gdlHandle hGdl, gdlShape shape1, gdlShape shape2, intl* distance );

Arguments

hGdl

The gdlHandle initialized by gdlInitialize. Input.

shape1

The gdlShape object representing the error surface. Input.

shape2

The gdlShape object representing the object found using gdlfindnearest (or gdlfindnext). Input.

distance

The distance in feet. Output.

Return values

GDL_NOT_LICENSED

GDL_ERROR

GDL_OK

Prerequisites

gdlFindNearest

gdlGenerateErrorSurface

Alternates

None.

Notes

The order of the objects does not affect the distance returned. However, for consistency, Precisely recommends that the error surface be passed as shape1.

The following diagram illustrates the minimum distance between an error surface and a line: