Global Address Object:Setup Methods: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
m Admin moved page Global Address Object:Setup Functions to Global Address Object:Setup Methods without leaving a redirect
No edit summary
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Global Address Object:Reference|← Global Address Object Reference]]
{{GlobalAddressObjectNav
 
|MethodsCollapse=
{| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa; font-size:9pt; color:#0645ad; padding:8px 8px;"
}}
! style="text-align:left; color:black; border-bottom:1px solid #aaaaaa;"|'''Global Address Object Navigation'''
|-
| style="padding-right:220px;"|
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Introduction|Introduction]]
|-
|[[Global Address Object:Platforms and Functions|Platforms and Functions]]
|-
|[[Global Address Object:Licensing|Licensing]]
|-
|[[Global Address Object:Result Code Use|Result Code Use]]
|}
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Interface|Interface]]
|-
|[[Global Address Object:Address Handling|Address Handling]]
|-
|[[Global Address Object:Interface Use|Interface Use]]
|}
|-
|
{| class="mw-collapsible" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Functions|Functions]]
|-
|[[Global Address Object:Setup Functions|Setup Functions]]
|-
|[[Global Address Object:Input Methods|Input Methods]]
|-
|[[Global Address Object:Processing Methods|Processing Methods]]
|-
|[[Global Address Object:Output Methods|Output Methods]]
|}
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Parameters|Parameters]]
|-
|[[Global Address Object:Processing Configuration Parameters|Processing Configuration Parameters]]
|-
|[[Global Address Object:Input Address Data Parameters|Input Address Data Parameters]]
|-
|[[Global Address Object:Output Address Data Parameters|Output Address Data Parameters]]
|}
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Global Address Object:Result Codes|Result Codes]]
|-
|[[Returned Result Codes:APIs#Global Address Object|Returned Result Codes]]
|-
|[[Global Address Object:Other Codes|Other Codes]]
|}
|}
 


{{CustomTOC}}
{{CustomTOC}}


==Setup Functions==
==Setup Methods==
===SetLicenseString===
<h3 style="background-color:rgb(240,240,240);">SetLicenseString</h3>
This function is used to set the license string into the Global Address Object.  This can also be accomplished by utilizing an environmental variable.
:This function is used to set the License Key into the Global Address Object.  This can also be accomplished by utilizing an environmental variable.


===SetPathToGlobalAddrFiles===
<h3 style="background-color:rgb(240,240,240);">SetPathToGlobalAddrFiles</h3>
This function is used to set the physical path to the Global Address Object’s reference data files.
:This function is used to set the physical path to the Global Address Object’s reference data files.


===InitializeDataFiles===
<h3 style="background-color:rgb(240,240,240);">InitializeDataFiles</h3>
This function initializes access to the reference data files set in SetPathToGlobalAddrFiles and activated via license key.
:This function initializes access to the reference data files set in SetPathToGlobalAddrFiles and activated via License Key.


===GetInitializeErrorString===
<h3 style="background-color:rgb(240,240,240);">GetInitializeErrorString</h3>
This function will return the error string detail related to a failure or error initializing the reference data file(s) and/or Global Address Object.
:This function will return the error string detail related to a failure or error initializing the reference data file(s) and/or Global Address Object.


===GetDatabaseDate===
<h3 style="background-color:rgb(240,240,240);">GetDatabaseDate</h3>
This function returns the build date for the reference data files utilizes by Global Address Object.
:This function returns the build date for the reference data files utilizes by Global Address Object.


===GetBuildNumber===
<h3 style="background-color:rgb(240,240,240);">GetBuildNumber</h3>
This function returns the version number for the Global Address Object
:This function returns the version number for the Global Address Object


===GetDatabaseExpirationDate===
<h3 style="background-color:rgb(240,240,240);">GetDatabaseExpirationDate</h3>
This function return the expiration date for the reference data files being used by Global Address Object if applicable.
:This function return the expiration date for the reference data files being used by Global Address Object if applicable.


===GetLicenseExpirationDate===
<h3 style="background-color:rgb(240,240,240);">GetLicenseExpirationDate</h3>
This function returns the expiration date for the license key set in the environmental variable or by utilizing SetLicenseString.
:This function returns the expiration date for the License Key set in the environmental variable or by utilizing SetLicenseString.




[[Category:Global Address Object]]
[[Category:Global Address Object]]
[[Category:Reference]]
[[Category:Reference]]

Latest revision as of 00:49, 21 September 2017

← Global Address Object Reference

Global Address Object Navigation
Introduction
System Requirements
Setup
Licensing
Interface
Address Handling
Interface Use
Methods
Setup Methods
Input Methods
Processing Methods
Output Methods
Parameters
Input Parameters
Output Parameters
Result Codes
Global Address Object Result Codes
Other Codes



Setup Methods

SetLicenseString

This function is used to set the License Key into the Global Address Object. This can also be accomplished by utilizing an environmental variable.

SetPathToGlobalAddrFiles

This function is used to set the physical path to the Global Address Object’s reference data files.

InitializeDataFiles

This function initializes access to the reference data files set in SetPathToGlobalAddrFiles and activated via License Key.

GetInitializeErrorString

This function will return the error string detail related to a failure or error initializing the reference data file(s) and/or Global Address Object.

GetDatabaseDate

This function returns the build date for the reference data files utilizes by Global Address Object.

GetBuildNumber

This function returns the version number for the Global Address Object

GetDatabaseExpirationDate

This function return the expiration date for the reference data files being used by Global Address Object if applicable.

GetLicenseExpirationDate

This function returns the expiration date for the License Key set in the environmental variable or by utilizing SetLicenseString.