GSFFSEG - geostan_1 - 2024.01

GeoStan Geocoding Suite Reference for Windows, Linux, and z/OS

Product type
Software
Portfolio
Locate
Product family
GeoStan Geocoding Suite
Product
GeoStan Geocoding Suite > GeoStan
Version
2024.01
Language
English
Product name
GeoStan
Title
GeoStan Geocoding Suite Reference for Windows, Linux, and z/OS
Copyright
2024
First publish date
1994
Last updated
2024-07-29
Published on
2024-07-29T23:01:18.924000

Finds the first segment object that meets the search criteria.

Syntax

01 GSID                  PIC S9(9) BINARY.
01 GSFUNSTAT             PIC S9(9) BINARY.
01 SEGMENT-HANDLE        PIC S9(9) BINARY.
*
CALL "GSFFSEG" USING GSID, SEGMENT-HANDLE, GSFUNSTAT.

Arguments

GSID   ID returned by GSINITWP for the current instance of GeoStan. Input.

GSFUNSTAT   Return value for the procedure. Output.

SEGMENT-HANDLE    Pointer to a street/segment handle. Returns a valid handle if GeoStan finds a segment. Input, Output.

Return Values

GSGS-SUCCESS    Found a match. You can retrieve the data for that match using GSHGET.

GS-NOT-FOUND    Did not find a match.

GS-ERROR    An error occurred; use GSERRGET and GSERRGTX to retrieve more information.

Prerequisites

GSINITWP and GSCLEAR

Notes

This procedure finds the first street in the current search area that meets the name criteria, and also sets the area and criteria for subsequent segment and range searches.

If you are using GSFFSEG to find a street that has a number as a component of the street name, such as "US HWY 41," or "I-95," enter just the number; the text is not part of the index for such streets.

GSFFSEG and GSFNRANG procedures work together to allow you to access to the entire address directory database.

See Extracting Data from GSD Files for more information on the Find First and Find Next procedures.