GsVerifyGSDDataPresent - geostan_1 - 2024.01

Validates the presence of data for specified states in the GSD data file.

Syntax

GsFunStat GsVerifyGSDDataPresent (GsId gs, GsStateList states)

Arguments

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

GsStateListstates      Structure containing state abbreviations and/or FIPS codes. Input.

Return Values

GS_SUCCESS    All states or FIPS codes specified in states are present in GSD data.

GS_GSD_DATA_MISSING One or more states or FIPS codes specified in states are not present in GSD data.

GS_ERROR    states structure is invalid.

Prerequisites

You must create a valid GsId with a call to GsInitWithProps().

If GeoStan did not find the GSD primary data for all the specified states, this function creates an error in the error list retrievable using GSErrorGetEx. The error message code is 114 and the error message is "NO GSD DATA FOUND FOR STATE" and indicates which states GeoStan did not find.

The state abbreviations and corresponding state FIPS codes are as follows:

The following pseudo FIPS codes support APO and FPO addresses:

GsVerifyGSDDataPresent() uses the GsStateList structure to pass in a list of state abbreviations or state FIPS codes to verify their presence in the GSD data. This structure contains the following:

typedef struct GsStateList
  {
  char *state[100]; /* array of 2 char null terminated strings */
  int cnt;         /* entries in 'state' that are filled in */
  } 
   GsStateList;

Example

typedef struct GsStateList
{
char state[100][3];  /* array of 2 char null terminated strings */
int cnt;             /* entries in 'state' that are filled in */
}
GsStateList;
             
GsStateList states;
char error_buffer[256];
char details_buffer[256];
             
/* populate states structure with all states that are required to be in the GSD data in order 
   to create a CASS report */          
/* Note: Test for CASS required GSD data is not a fatal error so the 'error' flag is not set */
             
states.cnt = 0;
strcpy(states.state[states.cnt++], "AL");
strcpy(states.state[states.cnt++], "AK");
strcpy(states.state[states.cnt++], "AZ");
/* additional states can be copied into the array here */
             
              ....
strcpy(states.state[states.cnt++], "AA");
               
if (GsVerifyGSDDataPresent(process->gs, states) == GS_SUCCESS)
    process->hasCASSRequiredData = 1;
else
{
process->hasCASSRequiredData = 0;
while ( GsErrorHas(process->gs))
GsErrorGetEx (process->gs, error_buffer, details_buffer);
printf ( "%s: %s\n", error_buffer, details_buffer ); /* report the errors */
}