Home
Defining C functions
Get to know the public functions of the C API
GsInitWithProps properties

Before You Begin
Get to know the purpose and use of this guide, and how to obtain assistance from Precisely
Getting started
Get to know the use and functionality of GeoStan
Using GeoStan
Get to know the concepts used by GeoStan
Defining C functions
Get to know the public functions of the C API
Defining COBOL procedures
Get to know about the public functions, data types, copybooks, and procedures
Java Quick Reference
List of the classes that compose the GeoStan Java API
.Net Quick Reference
List of the classes that compose the GeoStan.Net API
Deprecated functions
Get to know about the deprecated C functions and COBOL procedures
Extracting Data from GSD Files
Get to know how to access the information contained within the GSD files via the functions in GeoStan
Sample applications
Sample program that demonstrates the functionality of GeoStan. Geotest is located in the 64bit Windows or samples (UNIX) directory
Status codes
Different status codes returned by GeoStan through GS_MATCH_CODE and GS_LOC_CODE used with GsDataGet.
CASS certification
Details about CASS Certification, CASS Report, Obtaining USPS CASS certification for applications, and Modifying the CASS 3553 report template
USPS Link products
Get to know about USPS Link products, Implementing LACS and DPV, False positive report example code, and Reporting a false positive address.
User-defined data files
Information on creating User Dictionaries, source data requirements and required fields, and other information specific to working with User Dictionaries.
Glossary
Notices

GsInitWithProps properties

GsInitWithProps input properties

GS_INIT_CACHESIZE


Type	Long
Description	Relative cache size used by GeoStan. Controls the amount of memory that GeoStan allocates to store temporary street data during address processing. A smaller cache may slow the performance of GeoStan. A cache size of 2 gives best performance, but uses more memory.
Values	0,1, or 2.
Default value	1
Relation to deprecated feature	GsInit_r

GS_INIT_DATAPATH


Type	String
Description	List of paths to search for necessary files.
Values	On Windows and Unix, a semi-colon delimited path where GeoStan data files are located.
Default value	None
Relation to deprecated feature	GsInit_r

GS_INIT_DPV


Type	Boolean
Description	Initialize DPV.
Values	True or False.
Default value	False
Relation to deprecated feature	GsInitDpv_r

GS_INIT_GSVERSION


Type	Long
Description	GeoStan version.
Values	GS_GEOSTAN_VERSION from geostan.h
Default value	None
Relation to deprecated feature	GsInit_r

GS_INIT_LACSLINK


Type	Boolean
Description	Initialize LACS^Link.
Values	True or False.
Default value	False
Relation to deprecated feature	GsInitLACSLink_r

GS_INIT_LICFILENAME


Type	String
Description	License file name.
Values	Path and file name of the license file.
Default value	None
Relation to deprecated feature	GsSetLicense and GsInit_r

GS_INIT_OPTIONS_ADDR_CODE


Type	Boolean
Description	Open files needed for address standardization and geocoding.
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GS_FILE_ADDR_CODE and GsInit_r.

GS_INIT_OPTIONS_Z9_CODE


Type	Boolean
Description	Open files needed for ZIP centroid geocoding.
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GS_FILE_Z9_CODE and GsInit_r.

GS_INIT_OPTIONS_ZIP_PBKEYS


Type	Boolean
Description	Open file needed to return PreciselyIDs for ZIP centroid locations in Master Location Data. When an address point is not available for an address in Master Location Data, this option returns a ZIP centroid and the PreciselyIDunique identifier, which can be used to unlock additional information about an address using GeoEnrichment data. To enable returning PreciselyIDs for ZIP centroid locations in MLD, the GS_FIND_Z_CODE GsFindWithProps property needs to be enabled. If it is not enabled, an "E" location code is returned and the results data will not include a geocode nor PreciselyID.
Values	True or False.
Default value	False
Relation to deprecated feature	None

GS_INIT_OPTIONS_SPATIAL_QUERY


Type	Boolean
Description	Open spatial query files.
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GS_FILE_SPATIAL_QUERY.

GS_INIT_PASSWORD


Type	Long
Description	Long License password.
Values	License password provided by Precisely.
Default value	None
Relation to deprecated feature	GsSetLicense and GsInit_r

GS_INIT_RELDATE


Type	String
Description	String of the latest data to use in initialization.
Values	Date/Vintage of data to load in the format YYYYMM15
Default value	None
Relation to deprecated feature	GsInit_r

GS_INIT_Z4FILE


Type	String
Description	Name of the ZIP +4 directory file, us.z9.
Values	Path and file name of us.z9 file
Default value	None
Relation to deprecated feature	GsInit_r

GS_INIT_DPV_DATA_ACCESS


Type	Long
Description	Indicates the type of files to load and how to access the files. The following table contains the possible values.
Values	Indicates the type of files to load and how to access the files. • DPV_DATA_FULL_FILEIO – dpvh.db accessed via file I/O and Micro (U) memory model. This is a default value. • DPV_DATA_FULL_MEMORY – dpvh.db loaded completely into memory and Huge (H) memory model (about 1.3 GB). Use this option to gain performance improvement by reducing repetitive file I/O. • DPV_DATA_SPLIT_FILEIO - dpvs.db accessed via file I/O and Micro (U) memory model. Use if your file is sorted by ZIP Code and you have limited memory. Uses a split data format that separates the DPV data file into multiple smaller files, based on the first 2 digits of the ZIP Code. If you sort your mailing file by ZIP Code, you can use this value to bring the relevant portion of the DPV file into memory. This process uses 32 MB of storage, but reduces the number of I/O requests that normally occurs when you use the full DPV data. file. • DPV_DATA_SPLIT_MEMORY – dpvs.db loaded completely into memory and Huge (H) memory model (about 965 MB) • DPV_DATA_FLAT_FILEIO - dpv.db accessed via file I/O and Micro (U) memory model. • DPV_DATA_FLAT_MEMORY – dpv.db Large (L) memory model (about 70 MB). This configuration will provide the best performance overall.
Default value	DPV_DATA_FULL_FILEIO
Relation to deprecated feature	Overrides DpvInitStruct.

GS_INIT_DPV_DIRECTORY


Type	String
Description	String that specifies the directory containing DPV data.
Values	Path to directory where DPV data file resides.
Default value	None
Relation to deprecated feature	Overrides DpvInitStruct

GS_INIT_DPV_SECURITYKEY


Type	String
Description	Security key for product authorization.
Values	DPV security key from Precisely.
Default value	None
Relation to deprecated feature	Overrides DpvInitStruct.

GS_INIT_FILE_MEMORY_LIMIT


Type	Long
Description	Note: This property only applies to 64-bit applications. When GeoStan is initialized, it will memory-map as many data files into memory as the GS_INIT_FILE_MEMORY_LIMIT allows. The default value of 16 GB is sufficient for memory-mapping two streets and two points data sets. Memory mapping your data files can provide a 10-15% performance improvement compared to mapping none of them. However, if your environment has memory constraints, you can set the GS_INIT_FILE_MEMORY_LIMIT to the number of megabytes you can afford. This initialization property can only be set once per GeoStan executable process. If you attempt to set this property again (i.e., on a separate thread), the request is ignored. If all of the data files cannot be memory-mapped in the space provided, the status property GS_STATUS_FILE_MEM_SYS_EXCDD is set to true. To see how much virtual memory is being used for memory-mapping data files, query the status property GS_STATUS_MEMORY_USED.
Values	0 - 256000 (megabytes)
Default value	16000 (megabytes)
Relation to deprecated feature	GsSetFileMemoryLimit

GS_INIT_GEOSTAN_ID


Type	Long
Description	GeoStan ID.
Values	If NULL, this means initialize GeoStan.
Default value	None
Relation to deprecated feature	GsInit_r

Note: The GS_INIT_GEOSTAN_ID input property only works on 32-bit systems and has been deprecated. Use the GS_INIT_GS_ID input property defined on page 151.

GS_INIT_GS_ID


Type	Pointer
Description	The GsID returned by GsInitWithProps.
Values	64-bit integer value of GeoStan ID
Default value	NULL
Relation to deprecated feature	None

GS_INIT_LACSLINK_DIRECTORY


Type	String
Description	Directory of Lack^Link data.
Values	Path to directory where LACSLink data file resides.
Default value	None
Relation to deprecated feature	Overrides LACS^Link Init struct.

GS_INIT_LACSLINK_SECURITY_KEY


Type	String
Description	Security key.
Values	LACSLink security key from Precisely.
Default value	None
Relation to deprecated feature	Overrides LACS^Link Init struct.

GS_INIT_RDI_DIRECTORY


Type	String
Description	Directory containing USPS Residential Delivery Indicator (RDI) data, max 255 characters. Requires Delivery Point Validation (DPV).
Values	Path to directory where RDI data file resides.
Default value	None
Relation to deprecated feature	None

GS_INIT_SUITELINK


Type	Boolean
Description	Initializes Suite^Link .
Values	True or False.
Default value	False
Relation to deprecated feature	None

GS_INIT_SUITELINK_DIRECTORY


Type	String
Description	Directory containing Suite^Link data.
Values	Path to directory where SuiteLink data file resides.
Default value	None
Relation to deprecated feature	None

GsInitWithProps output status properties

GS_STATUS_FILE_ALIAS


Type	Boolean
Description	The street name alias file. Obsolete.
Values	True or False.
Default value	False
Relation to deprecated feature	None

GS_STATUS_FILE_AUXILIARY


Type	Boolean
Description	At least one auxiliary files loaded (*.gax).
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GS_FILE_AUXILIARY.

GS_STATUS_STATUS_BITFIELD


Type	Long
Description	GsInitStruct status bitfield for backwards compatibility.
Values	integer value representing deprecated return value from GsInit_r
Default value	0
Relation to deprecated feature	GsInit_r

GS_STATUS_FILE_CBSA_DIR


Type	Boolean
Description	The CBSA file loaded successfully (cbsac.dir).
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GS_FILE_CBSA_DIR.

GS_STATUS_FILE_CENTRUS_ALIAS


Type	Boolean
Description	The Centrus Alias file (usca.gsi) loaded successfully.
Values	True or False.
Default value	False
Relation to deprecated feature	None

GS_STATUS_FILE_CITY_DIR


Type	Boolean
Description	The city lookup file loaded successfully (ctyst.dir).
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GS_FILE_CITY_DIR.

GS_STATUS_DPV_FILE_ALL


Type	Boolean
Description	DPV data loaded successfully.
Values	True or False.
Default value	False
Relation to deprecated feature	GsInitDpv_r

GS_STATUS_DPV_FILE_SECURITY


Type	Boolean
Description	DPV security key verified successfully.
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GsInitDpv_r.

GS_STATUS_FILE_ERROR_INFO


Type	Boolean
Description	Error information is available from GeoStan via GsErrorGetEx.
Values	True or False.
Default value	False
Relation to deprecated feature	GsErrorHas

GS_STATUS_FILE_EWS


Type	Boolean
Description	EWS file loaded successfully (EWS.txt).
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GS_FILE_EWS.

GS_STATUS_FILE_EXP_CENTROIDS


Type	Boolean
Description	The Expanded Centroids file (us_cent.gsc) loaded successfully.
Values	True or False.
Default value	False
Relation to deprecated feature	None

GS_STATUS_FILE_EXPIRED


Type	Boolean
Description	One or more GSD files have expired (output only).
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GS_FILE_EXPIRED.

GS_STATUS_FILE_GEO_DIR


Type	Boolean
Description	The GeoStan directory file loaded successfully (*.gsd).
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GS_FILE_GEO_DIR.

GS_STATUS_FILE_LICENSE


Type	Boolean
Description	The license file (*.lic).
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GS_FILE_LICENSE.

GS_STATUS_FILE_LOT


Type	Boolean
Description	ELOT/Z4Change file loaded successfully (us.gsl).
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GS_FILE_LOT.

GS_STATUS_FILE_MEM_LIM_EXCDD


Type	Boolean
Description	Requested file memory limit exceeded.
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GS_FILE_MEM_LIM_EXCDD.

GS_STATUS_FILE_MEM_SYS_EXCDD


Type	Boolean
Description	System resources exceeded, preventing memory mapping.
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GS_FILE_MEM_SYS_EXCDD.

GS_STATUS_FILE_MEMORY_USED


Type	Long
Description	Amount of memory used by file memory limits.
Values	Integer value of memory mapped in MB.
Default value	0
Relation to deprecated feature	There is no direct equivalent in the deprecated API. GsSetFileMemoryLimit() sets the file memory limit, but the old API does not return how much memory was actually mapped.

GS_STATUS_FILE_MLD_EXTENDED_ATTR


Type	Boolean
Description	The Master Location Data Extended Attributes DLD files (extatt*p.dld) loaded successfully.
Values	True or False.
Default value	False
Relation to deprecated feature	None

GS_STATUS_FILE_PARSE_TABLES


Type	Boolean
Description	The parsing tables (parse.dir) loaded successfully.
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GS_FILE_PARSE_TABLES.

GS_STATUS_FILE_POI_IDX


Type	Boolean
Description	The optional POI Index file (poi.gsi) that contains firm, building and POI names loaded successfully.
Values	True or False.
Default value	False
Relation to deprecated feature	None.

GS_STATUS_FILE_PREMIUM_POI_IDX


Type	Boolean
Description	The optional Premium POI Index files (ppoi1.gsi, 2.gsi, 3.gsi) that contain firm, building and POI names loaded successfully.
Values	True or False.
Default value	False
Relation to deprecated feature	None.

GS_STATUS_FILE_POSTTYPE_XLAT


Type	Boolean
Description	The street type lookup file loaded successfully. Obsolete.
Values	True or False.
Default value	False
Relation to deprecated feature	None.

GS_STATUS_FILE_REVERSE_ALIAS


Type	Boolean
Description	Indexes file (usps.gdi) loaded successfully.
Values	True or False.
Default value	False
Relation to deprecated feature	None

GS_STATUS_FILE_REVERSE_PBKEY


Type	Boolean
Description	The Reverse PreciselyID Lookup files (*.pbk) loaded successfully.
Values	True or False.
Default value	False
Relation to deprecated feature	None

GS_STATUS_FILE_SPATIAL_QUERY


Type	Boolean
Description	Spatial query file loaded successfully (finmbr.dat).
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GS_FILE_SPATIAL_QUERY.

GS_STATUS_FILE_STATE_XLAT


Type	Boolean
Description	The state lookup file loaded successfully. Obsolete.
Values	True or False.
Default value	False
Relation to deprecated feature	None

GS_STATUS_FILE_UD


Type	Boolean
Description	At least one User Dictionary loaded successfully.
Values	True or False.
Default value	False
Relation to deprecated feature	None

GS_STATUS_FILE_ZCF_DIR


Type	Boolean
Description	The ZIP Code file loaded successfully. Obsolete.
Values	True or False.
Default value	False
Relation to deprecated feature	None.

GS_STATUS_FILE_ZIP_PBKEYS


Type	Boolean
Description	The ZIP centroid file (zipsmld.gsd) that contains PreciselyIDs loaded successfully.
Values	True or False.
Default value	False
Relation to deprecated feature	None.

GS_STATUS_FILE_ZIP4CENT_DIR


Type	Boolean
Description	The ZIP + 4 centroid file loaded successfully (us.z9).
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GS_FILE_ZIP4CENT_DIR.

GS_STATUS_FILE_ZIP9_IDX


Type	Boolean
Description	ZIP9 index file loaded successfully (*.gsu).
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GS_FILE_ZIP9_IDX.

GS_STATUS_FILE_ZIPMOVE


Type	Boolean
Description	ZIPMove file loaded successfully (us.gsz).
Values	True or False.
Default value	False
Relation to deprecated feature	Overrides GS_FILE_ZIPMOVE.

GS_STATUS_LACSLINK_FILE_ALL


Type	Boolean
Description	LACS^Link data loaded successfully..
Values	True or False.
Default value	False
Relation to deprecated feature	None

GS_STATUS_LACSLINK_FILE_SECUR


Type	Boolean
Description	LACS^Link security key verified successfully.
Values	True or False.
Default value	False
Relation to deprecated feature	None

GS_STATUS_RDI_FILE_ALL


Type	Boolean
Description	If true, RDI data initialized successfully.
Values	True or False.
Default value	False
Relation to deprecated feature	None

GS_STATUS_SUITELINK_FILE_ALL


Type	Boolean
Description	Suite^Link data loaded successfully.
Values	True or False.
Default value	False
Relation to deprecated feature	None