GsMultipleGet - geostan_1 - 2024.01

Returns the address elements for the match candidate specified.

Syntax

Arguments

GsIdgs   ID returned by GsInitWithProps for the current instance of GeoStan. Input.

GsEnumfSwitch   Enum for the argument you want to retrieve. Input.

intsindex   Entry number (0-based) of the possible match. Input.

pstrpBuffer   Location for the returned data. Output.

intsubufLen   Maximum size of data for GeoStan to return. If bufLen is shorter than the data returned by GeoStan, GeoStan truncates the data and does not generate an error. Input.

Return Values

GS_SUCCESS

GS_ERROR

Prerequisites

GsNumMultiple()

Notes

This function retrieves data from the GeoStan buffer for match candidates. GeoStan indicates a match candidate as the GS_ADDRESS_NOT_RESOLVED return code for GsFindWithProps.() It is important to first test for an intersection match, since the enums are different for retrieving intersection and non-intersection matches.

When using any street name enum (GS_NAME, GS_PREDIR, GS_POSTDIR, GS_TYPE), an additional modifier is available. You can use GS_ALIAS to request specific alias information, rather than preferred name information. For example in Boulder, CO, Wallstreet is an alias for Fourmile Canyon. 123 Wallstreet, Boulder CO 80301, matches to 123 Fourmile Canyon Dr.

GsMultipleGet( ..., GS_NAME,... ) returns "FOURMILE CANYON". GsMultipleGet( ...,GS_ALIAS | GS_NAME,... ) returns "WALLSTREET".

If you use GS_ALIAS with an enum that does not return alias information (such as GS_ZIP), GeoStan returns the information in the normal format. If GS_IS_ALIAS returns A07, you can only get information based on the returned address, not the alias.

When using GsDataGet(), returned results may be altered for the best match based on all the candidates found. GsMultipleGet() however does not change the results but provides raw data for the returned candidates. Therefore, some enums may differ from GsMultipleGet() and GsDataGet(). For example, GS_ADDRLINE, only contains information available from the candidate data records. If there is no unit low-high on the candidate, no unit information is added to the GS_ADDRLINE.

Example

/* This example prints information about possible matches. It assumes that GsFindWithProps 
   returned GS_ADDRESS_NOT_RESOLVED. */
             
char buffer[60];
int bInter;
             
printf( "Possibles:\n" );
/* Test for match candidate and set bInter to non-zero if true. */
GsMultipleGet( gs, GS_INTERSECTION, 0, buffer,sizeof(buffer) );
bInter = *buffer == 'T';
/* Get the number of multiples and print them as we loop through each one. */
int n = GsNumMultiple( gs );
for ( int i = 0; i < n; ++i )
  { 
  printf( "%d: ", i );
/* If we don't have an intersection, print the ranges. */
  if ( !bInter )
    {
   GsMultipleGet( gs, GS_LORANGE, i, buffer, sizeof(buffer) );
    printf( "%s ", buffer );
   GsMultipleGet( gs, GS_HIRANGE, i, buffer, sizeof(buffer) );
    printf( "%s ", buffer );
    }
/* Print the street name for both intersections and non intersections.*/
 GsMultipleGet( gs, GS_PREDIR, i, buffer, sizeof(buffer) );
  printf( "%s ", buffer );
 GsMultipleGet( gs, GS_NAME, i, buffer, sizeof(buffer) );
  printf( "%s ", buffer );
 GsMultipleGet( gs, GS_TYPE, i, buffer, sizeof(buffer) );
  printf( "%s ", buffer );
 GsMultipleGet( gs, GS_POSTDIR, i, buffer, sizeof(buffer) );
  printf( "%s ", buffer );
/* If an intersection match, print the second street name. */
  if ( bInter )
    {
    printf( " AT " );
   GsMultipleGet( gs, GS_PREDIR2, i, buffer, sizeof(buffer) );
    printf( "%s ", buffer );
   GsMultipleGet( gs, GS_NAME2, i, buffer, sizeof(buffer) );
    printf( "%s ", buffer );
   GsMultipleGet( gs, GS_TYPE2, i, buffer, sizeof(buffer) );
    printf("%s", buffer );
   GsMultipleGet( gs, GS_POSTDIR2, i, buffer, sizeof(buffer) );
    printf( "%s ", buffer );
    }
/* Print each possible on a new line. */
  printf( "(%s)\n", buffer );
}