GsDpvGetFalsePosHeaderStats - 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
Retrieves DPV statistics for the header record for a DVP false-positive report.
Note: If singleline address input is used, the output from GsDpvGetFalsePosHeaderStats will be incorrect.

Syntax

GsFunStat GsDpvGetFalsePosHeaderStats(GsId gs,GsFalsePosHeaderData *pdata, int structSize);

Arguments

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

GsFalsePosHeaderData *pdata   This structure retrieves DPV statistics for the header record for false-positive address matches using the data passed in GsFalsePosHeaderData. The output values are statistics for the false-positive reports. The input values include information to correctly complete the false-positive report for the USPS. This structure contains the following:

char MailersAddressLine   

Address of the mailer. Input.

char MailersCityName

City of the mailer. Input.

char MailerCompanyName

Name of the mailer. Input.

char MailersStateName

State of the mailer. Input.

char Mailers9DigitZip

ZIP Code of the mailer. Input.

intlu nNumberZipCodeOnFile   

Number of distinct ZIP Codes processed through DPV. Output.

intlu nTotalRecordsMatched

Number of records matched with DPV data. Output.

intlu nTotalRecordsProcessed

Number of records processed through DPV. Output.

intlu nTotalRecordsZIP4Matched   

Number of records that have matched with ZIP + 4. Output.

intlu NumberFalsePositives

Number of found DPV false-positive matches. Output.

intstructSize   Size of theGsFalsePosHeaderDatadata structure. Input

Return Values

GS_SUCCESS

GS_ERROR   Call GsErrorGetEx() for more information.

GS_WARNING   Call GsErrorGetEx() for more information.

Prerequisites

GsInitDpv_r()