gdlGetStreetLength - 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 street segment length or the length of a diagonal.

Syntax

intl gdlGetStreetLength( gdlHandle hGdl, GsId hGeostan, gdlShape* point, intl* length );

Arguments

hGdl

The gdlHandle initialized by gdlInitialize. Input.

hGeostan

The GsId from the GeoStan library. This handle must contain a valid GeoStan match. Input.

point

Pointer to a gdlShape representing the geocoded point. Output.

length

The length of the street segment, or the length of the MBR diagonal. Output.

Return values

GDL_ERROR

GDL_NOT_LICENSED

GDL_OK

Prerequisites

gdlInitialize, gsFind (from GeoStan)

Alternates

None.

Notes

Given a GeoStan handle, we can determine the street segment length for address level geocodes. The street length values can be used to make a fast determination of complete polygon inclusion when used in conjunction with the gdlPointInPolygon and gdlNearDistance functions.

If a ZIP-level geocode is returned, the distance for the minimum bounding rectangle (MBR) is also returned.

A GeoStan handle remains valid after calling gdlGetStreetLength.

Following instances of point arguments of this function, you should call gdlShapeFree with the output point when you are finished using the output point to release system resources.