FedExAddress Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to validate or complete recipient addresses.

Syntax

FedExAddress

Remarks

Via this class you can perform the following:

• Complete incomplete recipient addresses.
• Correct invalid recipient addresses.
• Determine whether an address is business or residential to increase the accuracy of courtesy rate quotes. This applies to U.S. and Canada addresses only.
• Confirm the validity and completeness of addresses in many countries in these regions: U.S., Canada, Latin America, Europe, the Middle East, and Asia Pacific.
• Provide street level matches.
• Find information on the nearest FedEx location(s).

Having correct addresses on the shipping labels will eliminate delivery delays and additional service fees (occurring when a shipment is re-routed).

For address verification, use the ValidateAddress method. This provides street level matches, but it does not currently verify suite or apartment numbers. It checks if the street exists in the city and state/province or postal code entered, and if the street number is within a valid range for the street entered. Upon successful reply, it either provides an exact match or possible alternatives (multiple address results) when an exact match cannot be found based on the input values, or informs you if no possible alternatives can be found.

For U.S. addresses, the following information is the minimum required to check an address:

• Street Address
• City and State/Province or Postal Code

To search for the nearest FedEx location(s), use the FindLocations method. You can search by address, geographic coordinates, or phone number.

To narrow down the search, you can specify the type of locations you are looking for (such as Authorized Ship Center, FedEx Self-Service, FedEx Staffed and/or) and any special service those locations offer (such as Accepts Cash, Saturday service, Packaging supplies, Latest Express drop-off, etc.).

If the request completes successfully, FedEx server will return a set of matches that satisfies the search criteria. You will be able to retrieve FedEx location Ids, addresses, available services they offer, operations hours on weekdays and/or weekends.

The set of locations retrieved is limited to a maximum of ten locations returned within a 50-mile radius.

To use this class, you must have an FedExAuthorizationToken, which is used to authorize your application API requests with FedEx resources.

You can obtain the FedExAuthorizationToken using the OAuth component. You'll need to provide the Client ID and Client Secret, which you can get from FedEx when you create your Project on the FedEx Developer portal.

FedEx allows this service to be used in production environment only after passing the certification. Customers need to be certified first in order to have the Advanced (such as Address Validation) services activated. After the certification is granted, you will receive the production credentials. Once they move to production, Address Validation is a feature that has to be activated upon the customer's request.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Address1 Property (FedExAddress Class)

Street name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAddress1();
int SetAddress1(const char* lpszAddress1);

Unicode (Windows)
LPWSTR GetAddress1();
INT SetAddress1(LPCWSTR lpszAddress1);

char* dshippingsdk_fedexaddress_getaddress1(void* lpObj);
int dshippingsdk_fedexaddress_setaddress1(void* lpObj, const char* lpszAddress1);

QString GetAddress1();
int SetAddress1(QString qsAddress1);

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS Address1 should not exceed 35 characters.

Data Type

String

Address2 Property (FedExAddress Class)

A specific detail on the address (such as building, suite, apartment, floor number etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAddress2();
int SetAddress2(const char* lpszAddress2);

Unicode (Windows)
LPWSTR GetAddress2();
INT SetAddress2(LPCWSTR lpszAddress2);

char* dshippingsdk_fedexaddress_getaddress2(void* lpObj);
int dshippingsdk_fedexaddress_setaddress2(void* lpObj, const char* lpszAddress2);

QString GetAddress2();
int SetAddress2(QString qsAddress2);

Default Value

""

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS Address2 should not exceed 35 characters.

Data Type

String

AddressFlags Property (FedExAddress Class)

Various flags that denote information about the address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAddressFlags();
int SetAddressFlags(int iAddressFlags);

Unicode (Windows)
INT GetAddressFlags();
INT SetAddressFlags(INT iAddressFlags);

int dshippingsdk_fedexaddress_getaddressflags(void* lpObj);
int dshippingsdk_fedexaddress_setaddressflags(void* lpObj, int iAddressFlags);

int GetAddressFlags();
int SetAddressFlags(int iAddressFlags);

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

City Property (FedExAddress Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCity();
int SetCity(const char* lpszCity);

Unicode (Windows)
LPWSTR GetCity();
INT SetCity(LPCWSTR lpszCity);

char* dshippingsdk_fedexaddress_getcity(void* lpObj);
int dshippingsdk_fedexaddress_setcity(void* lpObj, const char* lpszCity);

QString GetCity();
int SetCity(QString qsCity);

Default Value

""

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

Data Type

String

CountryCode Property (FedExAddress Class)

Country code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCountryCode();
int SetCountryCode(const char* lpszCountryCode);

Unicode (Windows)
LPWSTR GetCountryCode();
INT SetCountryCode(LPCWSTR lpszCountryCode);

char* dshippingsdk_fedexaddress_getcountrycode(void* lpObj);
int dshippingsdk_fedexaddress_setcountrycode(void* lpObj, const char* lpszCountryCode);

QString GetCountryCode();
int SetCountryCode(QString qsCountryCode);

Default Value

"US"

Remarks

Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.

* Not supported by USPS

** Has multiple values, the values used for USPS are below

Data Type

String

State Property (FedExAddress Class)

State or province code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetState();
int SetState(const char* lpszState);

Unicode (Windows)
LPWSTR GetState();
INT SetState(LPCWSTR lpszState);

char* dshippingsdk_fedexaddress_getstate(void* lpObj);
int dshippingsdk_fedexaddress_setstate(void* lpObj, const char* lpszState);

QString GetState();
int SetState(QString qsState);

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

Data Type

String

ZipCode Property (FedExAddress Class)

Postal code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetZipCode();
int SetZipCode(const char* lpszZipCode);

Unicode (Windows)
LPWSTR GetZipCode();
INT SetZipCode(LPCWSTR lpszZipCode);

char* dshippingsdk_fedexaddress_getzipcode(void* lpObj);
int dshippingsdk_fedexaddress_setzipcode(void* lpObj, const char* lpszZipCode);

QString GetZipCode();
int SetZipCode(QString qsZipCode);

Default Value

""

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both City and State are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 16.

Data Type

String

Company Property (FedExAddress Class)

Name of the company that resides at the address to be validated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCompany();
int SetCompany(const char* lpszCompany);

Unicode (Windows)
LPWSTR GetCompany();
INT SetCompany(LPCWSTR lpszCompany);

char* dshippingsdk_fedexaddress_getcompany(void* lpObj);
int dshippingsdk_fedexaddress_setcompany(void* lpObj, const char* lpszCompany);

QString GetCompany();
int SetCompany(QString qsCompany);

Default Value

""

Remarks

To narrow down the search for address candidates, you can include the Company in the address validation request (when the ValidateAddress is called). Providing a company name may improve your results since some addresses have specific company names assigned to them.

Data Type

String

ConstraintFilters Property (FedExAddress Class)

The following flags are defined (specified in hexadecimal notation).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConstraintFilters();
int SetConstraintFilters(int iConstraintFilters);

Unicode (Windows)
INT GetConstraintFilters();
INT SetConstraintFilters(INT iConstraintFilters);

int dshippingsdk_fedexaddress_getconstraintfilters(void* lpObj);
int dshippingsdk_fedexaddress_setconstraintfilters(void* lpObj, int iConstraintFilters);

int GetConstraintFilters();
int SetConstraintFilters(int iConstraintFilters);

Default Value

0

Remarks

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple filters:

Data Type

Integer

ConstraintLocationAttributes Property (FedExAddress Class)

This indicates the services you would like to search for at a particular location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConstraintLocationAttributes();
int SetConstraintLocationAttributes(int iConstraintLocationAttributes);

Unicode (Windows)
INT GetConstraintLocationAttributes();
INT SetConstraintLocationAttributes(INT iConstraintLocationAttributes);

int dshippingsdk_fedexaddress_getconstraintlocationattributes(void* lpObj);
int dshippingsdk_fedexaddress_setconstraintlocationattributes(void* lpObj, int iConstraintLocationAttributes);

int GetConstraintLocationAttributes();
int SetConstraintLocationAttributes(int iConstraintLocationAttributes);

Default Value

0

Remarks

This indicates the services you would like to search for at a particular location.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple attributes:

Data Type

Integer

ConstraintLocationContentOptions Property (FedExAddress Class)

This sets what content you would like to have returned with the location data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConstraintLocationContentOptions();
int SetConstraintLocationContentOptions(int iConstraintLocationContentOptions);

Unicode (Windows)
INT GetConstraintLocationContentOptions();
INT SetConstraintLocationContentOptions(INT iConstraintLocationContentOptions);

int dshippingsdk_fedexaddress_getconstraintlocationcontentoptions(void* lpObj);
int dshippingsdk_fedexaddress_setconstraintlocationcontentoptions(void* lpObj, int iConstraintLocationContentOptions);

int GetConstraintLocationContentOptions();
int SetConstraintLocationContentOptions(int iConstraintLocationContentOptions);

Default Value

0

Remarks

This sets what content you would like to have returned with the location data.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple attributes:

Data Type

Integer

ConstraintLocationTypeFlags Property (FedExAddress Class)

This indicates the type(s) of FedEx location you would like to search for.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConstraintLocationTypeFlags();
int SetConstraintLocationTypeFlags(int iConstraintLocationTypeFlags);

Unicode (Windows)
INT GetConstraintLocationTypeFlags();
INT SetConstraintLocationTypeFlags(INT iConstraintLocationTypeFlags);

int dshippingsdk_fedexaddress_getconstraintlocationtypeflags(void* lpObj);
int dshippingsdk_fedexaddress_setconstraintlocationtypeflags(void* lpObj, int iConstraintLocationTypeFlags);

int GetConstraintLocationTypeFlags();
int SetConstraintLocationTypeFlags(int iConstraintLocationTypeFlags);

Default Value

0

Remarks

This indicates the type(s) of FedEx location you would like to search for.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple location types:

Data Type

Integer

ConstraintRedirectToHoldType Property (FedExAddress Class)

Specify the type of service supported by a FedEx location for redirect to hold.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConstraintRedirectToHoldType();
int SetConstraintRedirectToHoldType(int iConstraintRedirectToHoldType);

Unicode (Windows)
INT GetConstraintRedirectToHoldType();
INT SetConstraintRedirectToHoldType(INT iConstraintRedirectToHoldType);

int dshippingsdk_fedexaddress_getconstraintredirecttoholdtype(void* lpObj);
int dshippingsdk_fedexaddress_setconstraintredirecttoholdtype(void* lpObj, int iConstraintRedirectToHoldType);

int GetConstraintRedirectToHoldType();
int SetConstraintRedirectToHoldType(int iConstraintRedirectToHoldType);

Default Value

0

Remarks

Specify the type of service supported by a FedEx location for redirect to hold.

Possible values are:

Data Type

Integer

ConstraintResultsRequested Property (FedExAddress Class)

The number of results requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConstraintResultsRequested();
int SetConstraintResultsRequested(int iConstraintResultsRequested);

Unicode (Windows)
INT GetConstraintResultsRequested();
INT SetConstraintResultsRequested(INT iConstraintResultsRequested);

int dshippingsdk_fedexaddress_getconstraintresultsrequested(void* lpObj);
int dshippingsdk_fedexaddress_setconstraintresultsrequested(void* lpObj, int iConstraintResultsRequested);

int GetConstraintResultsRequested();
int SetConstraintResultsRequested(int iConstraintResultsRequested);

Default Value

1

Remarks

The number of results requested.

Data Type

Integer

ConstraintResultsToSkip Property (FedExAddress Class)

The number of results to skip.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConstraintResultsToSkip();
int SetConstraintResultsToSkip(int iConstraintResultsToSkip);

Unicode (Windows)
INT GetConstraintResultsToSkip();
INT SetConstraintResultsToSkip(INT iConstraintResultsToSkip);

int dshippingsdk_fedexaddress_getconstraintresultstoskip(void* lpObj);
int dshippingsdk_fedexaddress_setconstraintresultstoskip(void* lpObj, int iConstraintResultsToSkip);

int GetConstraintResultsToSkip();
int SetConstraintResultsToSkip(int iConstraintResultsToSkip);

Default Value

0

Remarks

The number of results to skip.

Data Type

Integer

ConstraintSearchRadius Property (FedExAddress Class)

This contains the search radius to be used when FindLocations is called.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConstraintSearchRadius();
int SetConstraintSearchRadius(const char* lpszConstraintSearchRadius);

Unicode (Windows)
LPWSTR GetConstraintSearchRadius();
INT SetConstraintSearchRadius(LPCWSTR lpszConstraintSearchRadius);

char* dshippingsdk_fedexaddress_getconstraintsearchradius(void* lpObj);
int dshippingsdk_fedexaddress_setconstraintsearchradius(void* lpObj, const char* lpszConstraintSearchRadius);

QString GetConstraintSearchRadius();
int SetConstraintSearchRadius(QString qsConstraintSearchRadius);

Default Value

""

Remarks

This contains the search radius to be used when FindLocations is called.

Data Type

String

FedExAccountNumber Property (FedExAddress Class)

The account number associated with the shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFedExAccountNumber();
int SetFedExAccountNumber(const char* lpszFedExAccountNumber);

Unicode (Windows)
LPWSTR GetFedExAccountNumber();
INT SetFedExAccountNumber(LPCWSTR lpszFedExAccountNumber);

char* dshippingsdk_fedexaddress_getfedexaccountnumber(void* lpObj);
int dshippingsdk_fedexaddress_setfedexaccountnumber(void* lpObj, const char* lpszFedExAccountNumber);

QString GetFedExAccountNumber();
int SetFedExAccountNumber(QString qsFedExAccountNumber);

Default Value

""

Remarks

The account number associated with the shipment.

The FedExAccountNumber is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity.

Data Type

String

FedExAuthorizationToken Property (FedExAddress Class)

Authorization Token used to authenticate the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFedExAuthorizationToken();
int SetFedExAuthorizationToken(const char* lpszFedExAuthorizationToken);

Unicode (Windows)
LPWSTR GetFedExAuthorizationToken();
INT SetFedExAuthorizationToken(LPCWSTR lpszFedExAuthorizationToken);

char* dshippingsdk_fedexaddress_getfedexauthorizationtoken(void* lpObj);
int dshippingsdk_fedexaddress_setfedexauthorizationtoken(void* lpObj, const char* lpszFedExAuthorizationToken);

QString GetFedExAuthorizationToken();
int SetFedExAuthorizationToken(QString qsFedExAuthorizationToken);

Default Value

""

Remarks

Authorization Token used to authenticate the request.

This field should be set to the value of a bearer token obtained through OAuth 2.0. For more information on getting a bearer token, see the documentation for the OAuth component.

Data Type

String

FedExLanguageCode Property (FedExAddress Class)

Two-letter code for the language (e.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFedExLanguageCode();
int SetFedExLanguageCode(const char* lpszFedExLanguageCode);

Unicode (Windows)
LPWSTR GetFedExLanguageCode();
INT SetFedExLanguageCode(LPCWSTR lpszFedExLanguageCode);

char* dshippingsdk_fedexaddress_getfedexlanguagecode(void* lpObj);
int dshippingsdk_fedexaddress_setfedexlanguagecode(void* lpObj, const char* lpszFedExLanguageCode);

QString GetFedExLanguageCode();
int SetFedExLanguageCode(QString qsFedExLanguageCode);

Default Value

"en"

Remarks

Two-letter code for the language (e.g. en, fr, etc.).

This field allows you to assign the language code. Default value is en.

Data Type

String

FedExLocaleCode Property (FedExAddress Class)

Two-letter code for the region (e.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFedExLocaleCode();
int SetFedExLocaleCode(const char* lpszFedExLocaleCode);

Unicode (Windows)
LPWSTR GetFedExLocaleCode();
INT SetFedExLocaleCode(LPCWSTR lpszFedExLocaleCode);

char* dshippingsdk_fedexaddress_getfedexlocalecode(void* lpObj);
int dshippingsdk_fedexaddress_setfedexlocalecode(void* lpObj, const char* lpszFedExLocaleCode);

QString GetFedExLocaleCode();
int SetFedExLocaleCode(QString qsFedExLocaleCode);

Default Value

"US"

Remarks

Two-letter code for the region (e.g. US, CA, etc.).

Some languages require a locale code to further identify the language. Default value is US.

Data Type

String

FedExServer Property (FedExAddress Class)

URL for the FedEx Server where the requests are sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFedExServer();
int SetFedExServer(const char* lpszFedExServer);

Unicode (Windows)
LPWSTR GetFedExServer();
INT SetFedExServer(LPCWSTR lpszFedExServer);

char* dshippingsdk_fedexaddress_getfedexserver(void* lpObj);
int dshippingsdk_fedexaddress_setfedexserver(void* lpObj, const char* lpszFedExServer);

QString GetFedExServer();
int SetFedExServer(QString qsFedExServer);

Default Value

""

Remarks

URL for the FedEx Server where the requests are sent. This will overwrite the internal values that the component uses.

Normally, you do not need to set this property. By default, the component will send the request to the preset production end-point. In order to send request to the test environment, you must set the TESTMODE config to true like: component.Config("TESTMODE=true").

Data Type

String

FirewallAutoDetect Property (FedExAddress Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int dshippingsdk_fedexaddress_getfirewallautodetect(void* lpObj);
int dshippingsdk_fedexaddress_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (FedExAddress Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int dshippingsdk_fedexaddress_getfirewalltype(void* lpObj);
int dshippingsdk_fedexaddress_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (FedExAddress Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* dshippingsdk_fedexaddress_getfirewallhost(void* lpObj);
int dshippingsdk_fedexaddress_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (FedExAddress Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* dshippingsdk_fedexaddress_getfirewallpassword(void* lpObj);
int dshippingsdk_fedexaddress_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (FedExAddress Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int dshippingsdk_fedexaddress_getfirewallport(void* lpObj);
int dshippingsdk_fedexaddress_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (FedExAddress Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* dshippingsdk_fedexaddress_getfirewalluser(void* lpObj);
int dshippingsdk_fedexaddress_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

GeographicCoordinates Property (FedExAddress Class)

Specifies the geographic coordinates by which nearby FedEx locations are to be found.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGeographicCoordinates();
int SetGeographicCoordinates(const char* lpszGeographicCoordinates);

Unicode (Windows)
LPWSTR GetGeographicCoordinates();
INT SetGeographicCoordinates(LPCWSTR lpszGeographicCoordinates);

char* dshippingsdk_fedexaddress_getgeographiccoordinates(void* lpObj);
int dshippingsdk_fedexaddress_setgeographiccoordinates(void* lpObj, const char* lpszGeographicCoordinates);

QString GetGeographicCoordinates();
int SetGeographicCoordinates(QString qsGeographicCoordinates);

Default Value

""

Remarks

This property is optional, unless SearchCriteria is set to sctGeographicCoordinates.

The latitude and longitude should be specified in decimal format and separated by a comma. For example 35.912366,-78.939459

Data Type

String

LocationCount Property (FedExAddress Class)

The number of records in the Location arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocationCount();
int SetLocationCount(int iLocationCount);

Unicode (Windows)
INT GetLocationCount();
INT SetLocationCount(INT iLocationCount);

int dshippingsdk_fedexaddress_getlocationcount(void* lpObj);
int dshippingsdk_fedexaddress_setlocationcount(void* lpObj, int iLocationCount);

int GetLocationCount();
int SetLocationCount(int iLocationCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• LocationAcceptedCurrency
• LocationAttributes
• LocationCarrierCount
• LocationCarrierIndex
• LocationCarrierLatestDropoffCount
• LocationCarrierLatestDropoffDayOfWeek
• LocationCarrierLatestDropoffIndex
• LocationCarrierLatestDropoffOperationTime
• LocationCarrierType
• LocationCity
• LocationCompanyName
• LocationCountryCode
• LocationDistance
• LocationEmail
• LocationEntityId
• LocationFax
• LocationGeographicCoordinates
• LocationHolidayCount
• LocationHolidayDate
• LocationHolidayIndex
• LocationHolidayName
• LocationId
• LocationMapURL
• LocationPersonName
• LocationPhone
• LocationSpecialInstructions
• LocationState
• LocationStoreHoursCount
• LocationStoreHoursDayOfWeek
• LocationStoreHoursExceptionalHours
• LocationStoreHoursExceptionalHoursType
• LocationStoreHoursIndex
• LocationStoreHoursOperationalHours
• LocationStoreHoursOperationalHoursType
• LocationStoreNumber
• LocationStreetAddress
• LocationType
• LocationZipCode

The array indices start at 0 and end at LocationCount - 1.

This property is not available at design time.

Data Type

Integer

LocationAcceptedCurrency Property (FedExAddress Class)

The currency that is accepted at this FedEx location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationAcceptedCurrency(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationAcceptedCurrency(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationacceptedcurrency(void* lpObj, int locationindex);

QString GetLocationAcceptedCurrency(int iLocationIndex);

Default Value

""

Remarks

The currency that is accepted at this FedEx location. This is populated when FindLocations is called.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationAttributes Property (FedExAddress Class)

This specifies what type of services this FedEx location provides.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocationAttributes(int iLocationIndex);

Unicode (Windows)
INT GetLocationAttributes(INT iLocationIndex);

int dshippingsdk_fedexaddress_getlocationattributes(void* lpObj, int locationindex);

int GetLocationAttributes(int iLocationIndex);

Default Value

0

Remarks

This specifies what type of services this FedEx location provides. This is populated when FindLocations is called.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple attributes:

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

Integer

LocationCarrierCount Property (FedExAddress Class)

This contains the number of Carriers returned for the current location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocationCarrierCount(int iLocationIndex);

Unicode (Windows)
INT GetLocationCarrierCount(INT iLocationIndex);

int dshippingsdk_fedexaddress_getlocationcarriercount(void* lpObj, int locationindex);

int GetLocationCarrierCount(int iLocationIndex);

Default Value

0

Remarks

This contains the number of Carriers returned for the current location. This is populated after a call to FindLocations.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

Integer

LocationCarrierIndex Property (FedExAddress Class)

This contains the current index for the array of carriers that were returned for the current location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocationCarrierIndex(int iLocationIndex);
int SetLocationCarrierIndex(int iLocationIndex, int iLocationCarrierIndex);

Unicode (Windows)
INT GetLocationCarrierIndex(INT iLocationIndex);
INT SetLocationCarrierIndex(INT iLocationIndex, INT iLocationCarrierIndex);

int dshippingsdk_fedexaddress_getlocationcarrierindex(void* lpObj, int locationindex);
int dshippingsdk_fedexaddress_setlocationcarrierindex(void* lpObj, int locationindex, int iLocationCarrierIndex);

int GetLocationCarrierIndex(int iLocationIndex);
int SetLocationCarrierIndex(int iLocationIndex, int iLocationCarrierIndex);

Default Value

0

Remarks

This contains the current index for the array of carriers that were returned for the current location.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is not available at design time.

Data Type

Integer

LocationCarrierLatestDropoffCount Property (FedExAddress Class)

This contains the total number of normal latest dropoff times that were returned for the carrier specified by CarrierIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocationCarrierLatestDropoffCount(int iLocationIndex);

Unicode (Windows)
INT GetLocationCarrierLatestDropoffCount(INT iLocationIndex);

int dshippingsdk_fedexaddress_getlocationcarrierlatestdropoffcount(void* lpObj, int locationindex);

int GetLocationCarrierLatestDropoffCount(int iLocationIndex);

Default Value

0

Remarks

This contains the total number of normal latest dropoff times that were returned for the carrier specified by LocationCarrierIndex.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

Integer

LocationCarrierLatestDropoffDayOfWeek Property (FedExAddress Class)

This contains the day of the week for the current normal latest dropoff.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationCarrierLatestDropoffDayOfWeek(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationCarrierLatestDropoffDayOfWeek(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationcarrierlatestdropoffdayofweek(void* lpObj, int locationindex);

QString GetLocationCarrierLatestDropoffDayOfWeek(int iLocationIndex);

Default Value

""

Remarks

This contains the day of the week for the current normal latest dropoff. This is populated when LocationCarrierLatestDropoffIndex is set.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationCarrierLatestDropoffIndex Property (FedExAddress Class)

This specifies the index for the normal latest dropoff time for the carrier specified by CarrierIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocationCarrierLatestDropoffIndex(int iLocationIndex);
int SetLocationCarrierLatestDropoffIndex(int iLocationIndex, int iLocationCarrierLatestDropoffIndex);

Unicode (Windows)
INT GetLocationCarrierLatestDropoffIndex(INT iLocationIndex);
INT SetLocationCarrierLatestDropoffIndex(INT iLocationIndex, INT iLocationCarrierLatestDropoffIndex);

int dshippingsdk_fedexaddress_getlocationcarrierlatestdropoffindex(void* lpObj, int locationindex);
int dshippingsdk_fedexaddress_setlocationcarrierlatestdropoffindex(void* lpObj, int locationindex, int iLocationCarrierLatestDropoffIndex);

int GetLocationCarrierLatestDropoffIndex(int iLocationIndex);
int SetLocationCarrierLatestDropoffIndex(int iLocationIndex, int iLocationCarrierLatestDropoffIndex);

Default Value

0

Remarks

This specifies the index for the normal latest dropoff time for the carrier specified by LocationCarrierIndex. When LocationCarrierIndex is set, this gets set to 0.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is not available at design time.

Data Type

Integer

LocationCarrierLatestDropoffOperationTime Property (FedExAddress Class)

This contains the current carrier's normal dropoff time for the specified day.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationCarrierLatestDropoffOperationTime(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationCarrierLatestDropoffOperationTime(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationcarrierlatestdropoffoperationtime(void* lpObj, int locationindex);

QString GetLocationCarrierLatestDropoffOperationTime(int iLocationIndex);

Default Value

""

Remarks

This contains the current carrier's normal dropoff time for the specified day. This is populated when LocationCarrierLatestDropoffIndex is set.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationCarrierType Property (FedExAddress Class)

This contains the type of carrier the current carrier is.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocationCarrierType(int iLocationIndex);

Unicode (Windows)
INT GetLocationCarrierType(INT iLocationIndex);

LCT_FDXC(0), 
LCT_FDXE(1), 
LCT_FDXG(2), 
LCT_FXCC(3), 
LCT_FXFR(4), 
LCT_FXSP(5)

int dshippingsdk_fedexaddress_getlocationcarriertype(void* lpObj, int locationindex);

int GetLocationCarrierType(int iLocationIndex);

Default Value

0

Remarks

This contains the type of carrier the current carrier is. This is populated when LocationCarrierIndex is set.

The possible values are as follows:

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

Integer

LocationCity Property (FedExAddress Class)

Name of the city that the current location is in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationCity(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationCity(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationcity(void* lpObj, int locationindex);

QString GetLocationCity(int iLocationIndex);

Default Value

""

Remarks

Name of the city that the current location is in.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationCompanyName Property (FedExAddress Class)

The name of the business at this FedEx location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationCompanyName(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationCompanyName(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationcompanyname(void* lpObj, int locationindex);

QString GetLocationCompanyName(int iLocationIndex);

Default Value

""

Remarks

The name of the business at this FedEx location. This is populated when FindLocations is called.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationCountryCode Property (FedExAddress Class)

This contains the country code for the current location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationCountryCode(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationCountryCode(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationcountrycode(void* lpObj, int locationindex);

QString GetLocationCountryCode(int iLocationIndex);

Default Value

""

Remarks

This contains the country code for the current location. This is populated when FindLocations is called.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationDistance Property (FedExAddress Class)

Specifies the distance between the FedEx locations and the address specified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationDistance(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationDistance(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationdistance(void* lpObj, int locationindex);

QString GetLocationDistance(int iLocationIndex);

Default Value

""

Remarks

Specifies the distance between the FedEx locations and the address specified. For example: 1.7 MI. This is populated when FindLocations is called.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationEmail Property (FedExAddress Class)

The email address provided for the current location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationEmail(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationEmail(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationemail(void* lpObj, int locationindex);

QString GetLocationEmail(int iLocationIndex);

Default Value

""

Remarks

The email address provided for the current location. This is populated when FindLocations is called.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationEntityId Property (FedExAddress Class)

The entity ID for the current location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationEntityId(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationEntityId(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationentityid(void* lpObj, int locationindex);

QString GetLocationEntityId(int iLocationIndex);

Default Value

""

Remarks

The entity ID for the current location. This is populated when FindLocations is called.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationFax Property (FedExAddress Class)

This contains the fax number for the current location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationFax(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationFax(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationfax(void* lpObj, int locationindex);

QString GetLocationFax(int iLocationIndex);

Default Value

""

Remarks

This contains the fax number for the current location. This is populated when FindLocations is called.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationGeographicCoordinates Property (FedExAddress Class)

This contains the geographic coordinates of the current location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationGeographicCoordinates(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationGeographicCoordinates(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationgeographiccoordinates(void* lpObj, int locationindex);

QString GetLocationGeographicCoordinates(int iLocationIndex);

Default Value

""

Remarks

This contains the geographic coordinates of the current location. This is populated when FindLocations is called.

The latitude and longitude will be specified in decimal format and separated by a comma. For example 35.912366,-78.939459

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationHolidayCount Property (FedExAddress Class)

This contains the number of holidays that the current FedEx location observes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocationHolidayCount(int iLocationIndex);

Unicode (Windows)
INT GetLocationHolidayCount(INT iLocationIndex);

int dshippingsdk_fedexaddress_getlocationholidaycount(void* lpObj, int locationindex);

int GetLocationHolidayCount(int iLocationIndex);

Default Value

0

Remarks

This contains the number of holidays that the current FedEx location observes.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

Integer

LocationHolidayDate Property (FedExAddress Class)

This is the date of the holiday specified by HolidayIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationHolidayDate(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationHolidayDate(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationholidaydate(void* lpObj, int locationindex);

QString GetLocationHolidayDate(int iLocationIndex);

Default Value

""

Remarks

This is the date of the holiday specified by LocationHolidayIndex.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationHolidayIndex Property (FedExAddress Class)

This contains the index of the current holiday the FedEx location observes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocationHolidayIndex(int iLocationIndex);
int SetLocationHolidayIndex(int iLocationIndex, int iLocationHolidayIndex);

Unicode (Windows)
INT GetLocationHolidayIndex(INT iLocationIndex);
INT SetLocationHolidayIndex(INT iLocationIndex, INT iLocationHolidayIndex);

int dshippingsdk_fedexaddress_getlocationholidayindex(void* lpObj, int locationindex);
int dshippingsdk_fedexaddress_setlocationholidayindex(void* lpObj, int locationindex, int iLocationHolidayIndex);

int GetLocationHolidayIndex(int iLocationIndex);
int SetLocationHolidayIndex(int iLocationIndex, int iLocationHolidayIndex);

Default Value

0

Remarks

This contains the index of the current holiday the FedEx location observes.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is not available at design time.

Data Type

Integer

LocationHolidayName Property (FedExAddress Class)

This contains the name of the holiday specified by HolidayIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationHolidayName(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationHolidayName(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationholidayname(void* lpObj, int locationindex);

QString GetLocationHolidayName(int iLocationIndex);

Default Value

""

Remarks

This contains the name of the holiday specified by LocationHolidayIndex.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationId Property (FedExAddress Class)

Business identifier that can be used by IRV attendant to look directions to this FedEx location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationId(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationId(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationid(void* lpObj, int locationindex);

QString GetLocationId(int iLocationIndex);

Default Value

""

Remarks

Business identifier that can be used by IRV attendant to look directions to this FedEx location. This is populated when FindLocations is called.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationMapURL Property (FedExAddress Class)

This contains the URL to the google map showing the location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationMapURL(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationMapURL(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationmapurl(void* lpObj, int locationindex);

QString GetLocationMapURL(int iLocationIndex);

Default Value

""

Remarks

This contains the URL to the google map showing the location.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationPersonName Property (FedExAddress Class)

The name of the person listed as the contact for the current location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationPersonName(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationPersonName(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationpersonname(void* lpObj, int locationindex);

QString GetLocationPersonName(int iLocationIndex);

Default Value

""

Remarks

The name of the person listed as the contact for the current location. This is populated after a call to FindLocations.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationPhone Property (FedExAddress Class)

The phone number for the current location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationPhone(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationPhone(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationphone(void* lpObj, int locationindex);

QString GetLocationPhone(int iLocationIndex);

Default Value

""

Remarks

The phone number for the current location. This is populated after a call to FindLocations.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationSpecialInstructions Property (FedExAddress Class)

This contains any special instructions provided for the current location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationSpecialInstructions(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationSpecialInstructions(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationspecialinstructions(void* lpObj, int locationindex);

QString GetLocationSpecialInstructions(int iLocationIndex);

Default Value

""

Remarks

This contains any special instructions provided for the current location. This is populated after a call to FindLocations.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationState Property (FedExAddress Class)

State or province code of the current location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationState(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationState(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationstate(void* lpObj, int locationindex);

QString GetLocationState(int iLocationIndex);

Default Value

""

Remarks

State or province code of the current location. This is populated after a call to FindLocations.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationStoreHoursCount Property (FedExAddress Class)

This contains the number of store hours that were returned for the current location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocationStoreHoursCount(int iLocationIndex);

Unicode (Windows)
INT GetLocationStoreHoursCount(INT iLocationIndex);

int dshippingsdk_fedexaddress_getlocationstorehourscount(void* lpObj, int locationindex);

int GetLocationStoreHoursCount(int iLocationIndex);

Default Value

0

Remarks

This contains the number of store hours that were returned for the current location. This is populated after a call to FindLocations.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

Integer

LocationStoreHoursDayOfWeek Property (FedExAddress Class)

This contains the day of the week for which the store hours are being specified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationStoreHoursDayOfWeek(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationStoreHoursDayOfWeek(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationstorehoursdayofweek(void* lpObj, int locationindex);

QString GetLocationStoreHoursDayOfWeek(int iLocationIndex);

Default Value

""

Remarks

This contains the day of the week for which the store hours are being specified. This is populated when LocationStoreHoursIndex is set.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationStoreHoursExceptionalHours Property (FedExAddress Class)

This contains the list of operating hours for the location that are an exception from the normal hours of operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationStoreHoursExceptionalHours(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationStoreHoursExceptionalHours(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationstorehoursexceptionalhours(void* lpObj, int locationindex);

QString GetLocationStoreHoursExceptionalHours(int iLocationIndex);

Default Value

""

Remarks

This contains the list of operating hours for the location that are an exception from the normal hours of operation. This is populated when LocationStoreHoursIndex is set.

The format will be a 24 hour time format "HH:mm-HH:mm". For instance "09:00-16:00". If the location closes during the middle of the day so that it opens and closes twice in one day the sets will be separated by a comma. For instance "09:00-16:00,19:00-23:00" means the location is open from 9 a.m. to 4 p.m. and open again from 7 p.m. to 11 p.m.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationStoreHoursExceptionalHoursType Property (FedExAddress Class)

Indicates the type of exceptional hours.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationStoreHoursExceptionalHoursType(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationStoreHoursExceptionalHoursType(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationstorehoursexceptionalhourstype(void* lpObj, int locationindex);

QString GetLocationStoreHoursExceptionalHoursType(int iLocationIndex);

Default Value

""

Remarks

Indicates the type of exceptional hours. Possible returned values are: "CLOSED_ALL_DAY", "OPEN_ALL_DAY", "OPEN_BY_HOURS". This is populated when LocationStoreHoursIndex is set.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationStoreHoursIndex Property (FedExAddress Class)

This specifies the current index for the array containing the current location's store hours.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocationStoreHoursIndex(int iLocationIndex);
int SetLocationStoreHoursIndex(int iLocationIndex, int iLocationStoreHoursIndex);

Unicode (Windows)
INT GetLocationStoreHoursIndex(INT iLocationIndex);
INT SetLocationStoreHoursIndex(INT iLocationIndex, INT iLocationStoreHoursIndex);

int dshippingsdk_fedexaddress_getlocationstorehoursindex(void* lpObj, int locationindex);
int dshippingsdk_fedexaddress_setlocationstorehoursindex(void* lpObj, int locationindex, int iLocationStoreHoursIndex);

int GetLocationStoreHoursIndex(int iLocationIndex);
int SetLocationStoreHoursIndex(int iLocationIndex, int iLocationStoreHoursIndex);

Default Value

0

Remarks

This specifies the current index for the array containing the current location's store hours.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is not available at design time.

Data Type

Integer

LocationStoreHoursOperationalHours Property (FedExAddress Class)

This contains the list of normal operating hours for the location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationStoreHoursOperationalHours(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationStoreHoursOperationalHours(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationstorehoursoperationalhours(void* lpObj, int locationindex);

QString GetLocationStoreHoursOperationalHours(int iLocationIndex);

Default Value

""

Remarks

This contains the list of normal operating hours for the location. This is populated when LocationStoreHoursIndex is set.

The format will be a 24 hour time format "HH:mm-HH:mm". For instance "09:00-16:00". If the location closes during the middle of the day so that it opens and closes twice in one day the sets will be separated by a comma. For instance "09:00-16:00,19:00-23:00" means the location is open from 9 a.m. to 4 p.m. and open again from 7 p.m. to 11 p.m.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationStoreHoursOperationalHoursType Property (FedExAddress Class)

Indicates the type of operational hours.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationStoreHoursOperationalHoursType(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationStoreHoursOperationalHoursType(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationstorehoursoperationalhourstype(void* lpObj, int locationindex);

QString GetLocationStoreHoursOperationalHoursType(int iLocationIndex);

Default Value

""

Remarks

Indicates the type of operational hours. Possible returned values are: "CLOSED_ALL_DAY", "OPEN_ALL_DAY", "OPEN_BY_HOURS". This is populated when LocationStoreHoursIndex is set.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationStoreNumber Property (FedExAddress Class)

The store number for the current location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocationStoreNumber(int iLocationIndex);

Unicode (Windows)
INT GetLocationStoreNumber(INT iLocationIndex);

int dshippingsdk_fedexaddress_getlocationstorenumber(void* lpObj, int locationindex);

int GetLocationStoreNumber(int iLocationIndex);

Default Value

0

Remarks

The store number for the current location. This is populated after a call to FindLocations.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

Integer

LocationStreetAddress Property (FedExAddress Class)

Street address or intersection of this FedEx location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationStreetAddress(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationStreetAddress(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationstreetaddress(void* lpObj, int locationindex);

QString GetLocationStreetAddress(int iLocationIndex);

Default Value

""

Remarks

Street address or intersection of this FedEx location. This is populated after a call to FindLocations.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

LocationType Property (FedExAddress Class)

The type of this FedEx location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocationType(int iLocationIndex);
int SetLocationType(int iLocationIndex, int iLocationType);

Unicode (Windows)
INT GetLocationType(INT iLocationIndex);
INT SetLocationType(INT iLocationIndex, INT iLocationType);

FLT_AUTHORIZED_SHIP_CENTER(0), 
FLT_EXPRESS_STATION(1), 
FLT_FREIGHT_SERVICE_CENTER(2), 
FLT_GROUND_TERMINAL(3), 
FLT_HOME_DELIVERY_STATION(4), 
FLT_FED_EX_OFFICE(5), 
FLT_SELF_SERVICE_STATION(6), 
FLT_SMART_POST_HUB(7), 
FLT_FED_EX_FACILITY(8), 
FLT_FED_EX_ONSITE(9), 
FLT_FED_EX_SHIP_SITE(10)

int dshippingsdk_fedexaddress_getlocationtype(void* lpObj, int locationindex);
int dshippingsdk_fedexaddress_setlocationtype(void* lpObj, int locationindex, int iLocationType);

int GetLocationType(int iLocationIndex);
int SetLocationType(int iLocationIndex, int iLocationType);

Default Value

0

Remarks

The type of this FedEx location. This is populated after a call to FindLocations.

Possible values are as follows:

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is not available at design time.

Data Type

Integer

LocationZipCode Property (FedExAddress Class)

The postal code for the current location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocationZipCode(int iLocationIndex);

Unicode (Windows)
LPWSTR GetLocationZipCode(INT iLocationIndex);

char* dshippingsdk_fedexaddress_getlocationzipcode(void* lpObj, int locationindex);

QString GetLocationZipCode(int iLocationIndex);

Default Value

""

Remarks

The postal code for the current location. This is populated after a call to FindLocations.

The LocationIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String

MatchCount Property (FedExAddress Class)

The number of records in the Match arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMatchCount();

Unicode (Windows)
INT GetMatchCount();

int dshippingsdk_fedexaddress_getmatchcount(void* lpObj);

int GetMatchCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• MatchAddress1
• MatchAddress2
• MatchChangeType
• MatchCity
• MatchCompany
• MatchCountryCode
• MatchCustomerMessage
• MatchQuality
• MatchResidentialStatus
• MatchState
• MatchZipCode

The array indices start at 0 and end at MatchCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

MatchAddress1 Property (FedExAddress Class)

Address line 1 of an address candidate in the list of matches (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMatchAddress1(int iMatchIdx);

Unicode (Windows)
LPWSTR GetMatchAddress1(INT iMatchIdx);

char* dshippingsdk_fedexaddress_getmatchaddress1(void* lpObj, int matchidx);

QString GetMatchAddress1(int iMatchIdx);

Default Value

""

Remarks

Address line 1 of an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The MatchIdx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

This property is read-only and not available at design time.

Data Type

String

MatchAddress2 Property (FedExAddress Class)

Address line 2 of an address candidate in the list of matches (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMatchAddress2(int iMatchIdx);

Unicode (Windows)
LPWSTR GetMatchAddress2(INT iMatchIdx);

char* dshippingsdk_fedexaddress_getmatchaddress2(void* lpObj, int matchidx);

QString GetMatchAddress2(int iMatchIdx);

Default Value

""

Remarks

Address line 2 of an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The MatchIdx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

This property is read-only and not available at design time.

Data Type

String

MatchChangeType Property (FedExAddress Class)

Changes made to the Address (during validation process) compared to this address candidate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMatchChangeType(int iMatchIdx);

Unicode (Windows)
LPWSTR GetMatchChangeType(INT iMatchIdx);

char* dshippingsdk_fedexaddress_getmatchchangetype(void* lpObj, int matchidx);

QString GetMatchChangeType(int iMatchIdx);

Default Value

""

Remarks

Changes made to the Address (during validation process) compared to this address candidate. This is a comma-separated string collection. Possible returned values are

• APARTMENT_NUMBER_NOT_FOUND
• APARTMENT_NUMBER_REQUIRED
• NORMALIZED
• REMOVED_DATA
• BOX_NUMBER_REQUIRED
• NO_CHANGES
• MODIFIED_TO_ACHIEVE_MATCH
• STREET_RANGE_MATCH
• BOX_NUMBER_MATCH
• RR_OR_HC_MATCH
• CITY_MATCH
• POSTAL_CODE_MATCH
• RR_OR_HC_BOX_NUMBER_NEEDED
• FORMATTED_FOR_COUNTRY
• APO_OR_FPO_MATCH
• GENERAL_DELIVERY_MATCH
• FIELD_TRUNCATED
• UNABLE_TO_APPEND_NON_ADDRESS_DATA
• INSUFFICIENT_DATA
• HOUSE_OR_BOX_NUMBER_NOT_FOUND
• POSTAL_CODE_NOT_FOUND
• INVALID_COUNTRY
• SERVICE_UNAVAILABLE_FOR_ADDRESS

This is only valid for FedEx.

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The MatchIdx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

This property is read-only and not available at design time.

Data Type

String

MatchCity Property (FedExAddress Class)

City name of an address candidate in the list of matches (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMatchCity(int iMatchIdx);

Unicode (Windows)
LPWSTR GetMatchCity(INT iMatchIdx);

char* dshippingsdk_fedexaddress_getmatchcity(void* lpObj, int matchidx);

QString GetMatchCity(int iMatchIdx);

Default Value

""

Remarks

City name of an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The MatchIdx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

This property is read-only and not available at design time.

Data Type

String

MatchCompany Property (FedExAddress Class)

Name of the company that resides at an address candidate in the list of matches (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMatchCompany(int iMatchIdx);

Unicode (Windows)
LPWSTR GetMatchCompany(INT iMatchIdx);

char* dshippingsdk_fedexaddress_getmatchcompany(void* lpObj, int matchidx);

QString GetMatchCompany(int iMatchIdx);

Default Value

""

Remarks

Name of the company that resides at an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The MatchIdx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

This property is read-only and not available at design time.

Data Type

String

MatchCountryCode Property (FedExAddress Class)

Country code of an address candidate in the list of matches (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMatchCountryCode(int iMatchIdx);

Unicode (Windows)
LPWSTR GetMatchCountryCode(INT iMatchIdx);

char* dshippingsdk_fedexaddress_getmatchcountrycode(void* lpObj, int matchidx);

QString GetMatchCountryCode(int iMatchIdx);

Default Value

""

Remarks

Country code of an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The MatchIdx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

This property is read-only and not available at design time.

Data Type

String

MatchCustomerMessage Property (FedExAddress Class)

Messages pertaining to the resolved address indicating if any additional information is required.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMatchCustomerMessage(int iMatchIdx);

Unicode (Windows)
LPWSTR GetMatchCustomerMessage(INT iMatchIdx);

char* dshippingsdk_fedexaddress_getmatchcustomermessage(void* lpObj, int matchidx);

QString GetMatchCustomerMessage(int iMatchIdx);

Default Value

""

Remarks

Messages pertaining to the resolved address indicating if any additional information is required. This is a comma-separated string collection. Possible returned values are

This is only valid for FedEx.

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The MatchIdx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

This property is read-only and not available at design time.

Data Type

String

MatchQuality Property (FedExAddress Class)

Quality factor an address candidate in the list of matches (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMatchQuality(int iMatchIdx);

Unicode (Windows)
LPWSTR GetMatchQuality(INT iMatchIdx);

char* dshippingsdk_fedexaddress_getmatchquality(void* lpObj, int matchidx);

QString GetMatchQuality(int iMatchIdx);

Default Value

""

Remarks

Quality factor an address candidate in the list of matches (if any).

Each address is returned with an assigned quality value that indicates how closely the address candidate matches the search criteria. This is used to rate the submitted address. If the MatchQuality is too low, the class returns the "Address Not Validated" message.

In FedEx, possible values range from 0 to 100, with 100 being the highest and zero indicating failure.

In UPS, this is applicable for a non street-level address validation and/or classification (i.e., when the Address1 is not set in the request). Possible values are:

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The MatchIdx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

This property is read-only and not available at design time.

Data Type

String

MatchResidentialStatus Property (FedExAddress Class)

Residential status of an address candidate in the list of matches (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMatchResidentialStatus(int iMatchIdx);

Unicode (Windows)
LPWSTR GetMatchResidentialStatus(INT iMatchIdx);

char* dshippingsdk_fedexaddress_getmatchresidentialstatus(void* lpObj, int matchidx);

QString GetMatchResidentialStatus(int iMatchIdx);

Default Value

""

Remarks

Residential status of an address candidate in the list of matches (if any). Possible returned values are:

• MIXED
• UNKNOWN
• BUSINESS
• RESIDENTIAL

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The MatchIdx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

This property is read-only and not available at design time.

Data Type

String

MatchState Property (FedExAddress Class)

State or province code of an address candidate in the list of matches (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMatchState(int iMatchIdx);

Unicode (Windows)
LPWSTR GetMatchState(INT iMatchIdx);

char* dshippingsdk_fedexaddress_getmatchstate(void* lpObj, int matchidx);

QString GetMatchState(int iMatchIdx);

Default Value

""

Remarks

State or province code of an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The MatchIdx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

This property is read-only and not available at design time.

Data Type

String

MatchZipCode Property (FedExAddress Class)

Postal Code of an address candidate in the list of matches (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMatchZipCode(int iMatchIdx);

Unicode (Windows)
LPWSTR GetMatchZipCode(INT iMatchIdx);

char* dshippingsdk_fedexaddress_getmatchzipcode(void* lpObj, int matchidx);

QString GetMatchZipCode(int iMatchIdx);

Default Value

""

Remarks

Postal Code of an address candidate in the list of matches (if any).

This may be returned in the server response when the ValidateAddress method is called and if the connection to the server is successful (no errors returned).

The MatchIdx parameter specifies the index of the item in the array. The size of the array is controlled by the MatchCount property.

This property is read-only and not available at design time.

Data Type

String

MaxResults Property (FedExAddress Class)

The maximum number of results to be returned.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMaxResults();
int SetMaxResults(int iMaxResults);

Unicode (Windows)
INT GetMaxResults();
INT SetMaxResults(INT iMaxResults);

int dshippingsdk_fedexaddress_getmaxresults(void* lpObj);
int dshippingsdk_fedexaddress_setmaxresults(void* lpObj, int iMaxResults);

int GetMaxResults();
int SetMaxResults(int iMaxResults);

Default Value

10

Remarks

This specifies the maximum number of results to be returned. The default value is 10.

The maximum value for this property is 50.

Data Type

Integer

Phone Property (FedExAddress Class)

Phone number for which nearby FedEx locations are to be found.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPhone();
int SetPhone(const char* lpszPhone);

Unicode (Windows)
LPWSTR GetPhone();
INT SetPhone(LPCWSTR lpszPhone);

char* dshippingsdk_fedexaddress_getphone(void* lpObj);
int dshippingsdk_fedexaddress_setphone(void* lpObj, const char* lpszPhone);

QString GetPhone();
int SetPhone(QString qsPhone);

Default Value

""

Remarks

This property is optional, unless SearchCriteria is set to sctPhoneNumber.

Data Type

String

ProxyAuthScheme Property (FedExAddress Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int dshippingsdk_fedexaddress_getproxyauthscheme(void* lpObj);
int dshippingsdk_fedexaddress_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (FedExAddress Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int dshippingsdk_fedexaddress_getproxyautodetect(void* lpObj);
int dshippingsdk_fedexaddress_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (FedExAddress Class)

This property contains a password if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* dshippingsdk_fedexaddress_getproxypassword(void* lpObj);
int dshippingsdk_fedexaddress_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (FedExAddress Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int dshippingsdk_fedexaddress_getproxyport(void* lpObj);
int dshippingsdk_fedexaddress_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (FedExAddress Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* dshippingsdk_fedexaddress_getproxyserver(void* lpObj);
int dshippingsdk_fedexaddress_setproxyserver(void* lpObj, const char* lpszProxyServer);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (FedExAddress Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int dshippingsdk_fedexaddress_getproxyssl(void* lpObj);
int dshippingsdk_fedexaddress_setproxyssl(void* lpObj, int iProxySSL);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (FedExAddress Class)

This property contains a username if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* dshippingsdk_fedexaddress_getproxyuser(void* lpObj);
int dshippingsdk_fedexaddress_setproxyuser(void* lpObj, const char* lpszProxyUser);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

SearchCriteria Property (FedExAddress Class)

The criteria to be used to find FedEx Locations.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSearchCriteria();
int SetSearchCriteria(int iSearchCriteria);

Unicode (Windows)
INT GetSearchCriteria();
INT SetSearchCriteria(INT iSearchCriteria);

SCT_ADDRESS(0), 
SCT_GEOGRAPHIC_COORDINATES(1), 
SCT_PHONE_NUMBER(2)

int dshippingsdk_fedexaddress_getsearchcriteria(void* lpObj);
int dshippingsdk_fedexaddress_setsearchcriteria(void* lpObj, int iSearchCriteria);

int GetSearchCriteria();
int SetSearchCriteria(int iSearchCriteria);

Default Value

0

Remarks

This specifies what criteria is to be used to search for FedEx locations when FindLocations is called.

If sctAddress is specified, the Address, must be set. Likewise, if sctGeographicCoordinates is specified, GeographicCoordinates must be set and if sctPhoneNumber is specified PhoneNumber must be set.

Data Type

Integer

SortCriteria Property (FedExAddress Class)

The criteria to be used to sort the results.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSortCriteria();
int SetSortCriteria(int iSortCriteria);

Unicode (Windows)
INT GetSortCriteria();
INT SetSortCriteria(INT iSortCriteria);

SC_DISTANCE(0), 
SC_LATEST_EXPRESS_DROPOFF_TIME(1), 
SC_LATEST_GROUND_DROPOFF_TIME(2), 
SC_LOCATION_TYPE(3)

int dshippingsdk_fedexaddress_getsortcriteria(void* lpObj);
int dshippingsdk_fedexaddress_setsortcriteria(void* lpObj, int iSortCriteria);

int GetSortCriteria();
int SetSortCriteria(int iSortCriteria);

Default Value

0

Remarks

This specifies what criteria will be used to sort the results that are returned from FedEx when FindLocations is called.

Data Type

Integer

SSLAcceptServerCertEncoded Property (FedExAddress Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int dshippingsdk_fedexaddress_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dshippingsdk_fedexaddress_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (FedExAddress Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int dshippingsdk_fedexaddress_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dshippingsdk_fedexaddress_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (FedExAddress Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int dshippingsdk_fedexaddress_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dshippingsdk_fedexaddress_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (FedExAddress Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* dshippingsdk_fedexaddress_getsslcertstorepassword(void* lpObj);
int dshippingsdk_fedexaddress_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (FedExAddress Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int dshippingsdk_fedexaddress_getsslcertstoretype(void* lpObj);
int dshippingsdk_fedexaddress_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (FedExAddress Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* dshippingsdk_fedexaddress_getsslcertsubject(void* lpObj);
int dshippingsdk_fedexaddress_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (FedExAddress Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int dshippingsdk_fedexaddress_getsslprovider(void* lpObj);
int dshippingsdk_fedexaddress_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (FedExAddress Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int dshippingsdk_fedexaddress_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (FedExAddress Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int dshippingsdk_fedexaddress_gettimeout(void* lpObj);
int dshippingsdk_fedexaddress_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TotalLocationsFound Property (FedExAddress Class)

Specifies the total number of locations found.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTotalLocationsFound();
int SetTotalLocationsFound(int iTotalLocationsFound);

Unicode (Windows)
INT GetTotalLocationsFound();
INT SetTotalLocationsFound(INT iTotalLocationsFound);

int dshippingsdk_fedexaddress_gettotallocationsfound(void* lpObj);
int dshippingsdk_fedexaddress_settotallocationsfound(void* lpObj, int iTotalLocationsFound);

int GetTotalLocationsFound();
int SetTotalLocationsFound(int iTotalLocationsFound);

Default Value

0

Remarks

This specifies the total number of locations found based on the criteria provided when FindLocations is called.

Data Type

Integer

Config Method (FedExAddress Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* dshippingsdk_fedexaddress_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

FindLocations Method (FedExAddress Class)

Finds FedEx location(s) based on the input data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int FindLocations();

Unicode (Windows)
INT FindLocations();

int dshippingsdk_fedexaddress_findlocations(void* lpObj);

int FindLocations();

Remarks

FedEx drop-off locations can be searched by phone number or address. On each request, the following properties can be passed in the request (the optional ones are used to narrow down the search and the conditional ones depend on other property values):

• FedExServer (optional)
• FedExAccountNumber (optional)
• Phone (required if searched by phone number)
• Address (required if searched by address)
• ConstraintLocationTypeFlags (optional)

If there are any locations returned, the following properties will be filled:

• Location*

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (FedExAddress Class)

Resets the internal state of the class and all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dshippingsdk_fedexaddress_reset(void* lpObj);

int Reset();

Remarks

The Reset method does not have any parameters and does not return any value.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ValidateAddress Method (FedExAddress Class)

Returns the corrected and standardized address information or a list of candidates.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ValidateAddress();

Unicode (Windows)
INT ValidateAddress();

int dshippingsdk_fedexaddress_validateaddress(void* lpObj);

int ValidateAddress();

Remarks

This method is used to verify and correct the address specified by the Address.

Any of the following input combinations are valid:

• City, State and ZipCode
• City
• ZipCode
• City and State
• City and ZipCode
• State and ZipCode

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (FedExAddress Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(FedExAddressErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} FedExAddressErrorEventParams;


Unicode (Windows)
virtual INT FireError(FedExAddressErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} FedExAddressErrorEventParams;

#define EID_FEDEXADDRESS_ERROR 1

virtual INT DSHIPPINGSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class FedExAddressErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(FedExAddressErrorEventParams *e);

// Or, subclass FedExAddress and override this emitter function.
virtual int FireError(FedExAddressErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Notification Event (FedExAddress Class)

Notification returned by the server upon successful request (if applicable).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireNotification(FedExAddressNotificationEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} FedExAddressNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(FedExAddressNotificationEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} FedExAddressNotificationEventParams;

#define EID_FEDEXADDRESS_NOTIFICATION 2

virtual INT DSHIPPINGSDK_CALL FireNotification(LPSTR &lpszMessage);

class FedExAddressNotificationEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(FedExAddressNotificationEventParams *e);

// Or, subclass FedExAddress and override this emitter function.
virtual int FireNotification(FedExAddressNotificationEventParams *e) {...}

Remarks

When sending a request, the server may return with a successful reply or an error. However, even when a transaction is successful, a warning or a note might still be returned by the server. In such cases, the Notification event is fired.

Notifications returned through this event are non-fatal and shipments will still be processes, labels will still be printable, rates are still returned, etc. These notifications should be treated as informational only.

SSLServerAuthentication Event (FedExAddress Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt