MatchUp Object:Hybrid:Initialization - Revision history

Admin at 21:49, 19 December 2016

2016-12-19T21:49:32Z

← Older revision		Revision as of 21:49, 19 December 2016
Line 29:		Line 29:

	==SetLicenseString==		==SetLicenseString==
	This function passes the ~~license string~~ required for MatchUp Object to function. A value of "1" is returned if the ~~license string~~ is valid, a vlue of "0" is returned for an invalid or empty string.		This function passes the License Key required for MatchUp Object to function. A value of "1" is returned if the License Key is valid, a vlue of "0" is returned for an invalid or empty string.

	<span style="color:red;">This function is only required if the environment variable method is not used.</span>		<span style="color:red;">This function is only required if the environment variable method is not used.</span>

	Each customer is issued a ~~license string~~ when purchasing MatchUp Object or renewing a subscription. This string must be passed to this function to unlock the functionality of MatchUp Object.		Each customer is issued a License Key when purchasing MatchUp Object or renewing a subscription. This string must be passed to this function to unlock the functionality of MatchUp Object.

	The ~~license string~~ is normally set using an environment variable, either MD_LICENSE or MD_LICENSE_DEMO. Calling this function is an alternative method for setting the ~~license string~~, but applications developed for a production environment should only use the environment variable.		The License Key is normally set using an environment variable, either MD_LICENSE or MD_LICENSE_DEMO. Calling this function is an alternative method for setting the License Key, but applications developed for a production environment should only use the environment variable.

	When using an environment variable, it is not necessary to call this function.		When using an environment variable, it is not necessary to call this function.

	For more information on setting the environment variable, see [[MatchUp Object:Licensing#Entering Your MatchUp Object License\|Entering Your MatchUp Object License]].		For more information on setting the environment variable, see [[MatchUp Object:Licensing#Entering Your MatchUp Object License Key\|Entering Your MatchUp Object License Key]].

	{{ Object Syntax		{{ Object Syntax
Line 132:		Line 132:
	\|1\|\|ErrorConfigFile\|\|Could not find mdMatchUp.dat.		\|1\|\|ErrorConfigFile\|\|Could not find mdMatchUp.dat.
	\|-		\|-
	\|2\|\|ErrorLicenseExpired\|\|The License ~~String~~ has expired.		\|2\|\|ErrorLicenseExpired\|\|The License Key has expired.
	\|-		\|-
	\|3\|\|ErrorDatabaseExpired\|\|The database has expired.		\|3\|\|ErrorDatabaseExpired\|\|The database has expired.
Line 159:		Line 159:
	*"No error"		*"No error"
	*"Could not find mdMatchUp.dat."		*"Could not find mdMatchUp.dat."
	*"The License ~~String~~ has expired."		*"The License Key has expired."
	*"The database has expired."		*"The database has expired."
	*"No matchcode was specified."		*"No matchcode was specified."
Line 206:		Line 206:

	==GetLicenseExpirationDate==		==GetLicenseExpirationDate==
	This function returns a string value containing the expiration date of the current ~~license string~~. After this date, MatchUp Object will no longer function.		This function returns a string value containing the expiration date of the current License Key. After this date, MatchUp Object will no longer function.

	{{ Object Syntax		{{ Object Syntax

Admin at 23:35, 6 August 2015

2015-08-06T23:35:38Z

@@ Line 24: / Line 24: @@
 |Syntax=mdMU->SetPathToNameFiles(char)
 |C=mdMUHybridSetPathToMatchUpFiles(mdMU, char)
-|.Net=mdMU.PathToMatchUpFiles = string
+|.Net=mdMU.SetPathToMatchUpFiles = string
 }}
@@ Line 53: / Line 53: @@
 {{ Object Syntax
 |Syntax=mdMU->SetMatchcodeName(char)
-|C=mdMUHybridMatchcodeName(mdMU, char)
+|C=mdMUHybridSetMatchcodeName(mdMU, char)
-|.Net=mdMU.MatchcodeName = string
+|.Net=mdMU.SetMatchcodeName = string
 }}
@@ Line 70: / Line 70: @@
 |Syntax=mdMU->SetMatchcodeObject(mdMUMatchcode)
 |C=mdMUHybridSetMatchcodeObject(mdMU, mdMUMatchcode)
-|.Net=mdMU.MatchcodeObject = mdMUMatchcode
+|.Net=mdMU.SetMatchcodeObject = mdMUMatchcode
 }}

Admin at 17:38, 31 July 2015

2015-07-31T17:38:30Z

← Older revision		Revision as of 17:38, 31 July 2015
Line 79:		Line 79:
	Before calling this function, the application must have successfully called the [[#SetLicenseString\|SetLicenseString]] and [[#SetPathToMatchUpFiles\|SetPathToMatchUpFiles]] functions.		Before calling this function, the application must have successfully called the [[#SetLicenseString\|SetLicenseString]] and [[#SetPathToMatchUpFiles\|SetPathToMatchUpFiles]] functions.

	Check the return value of the [[#GetInitializeErrorString\|GetInitializeErrorString]] function to retrieve the result of the initialization call. Any result other than ~~“ErrorNone”~~ means the initialization failed for some reason.		Check the return value of the [[#GetInitializeErrorString\|GetInitializeErrorString]] function to retrieve the result of the initialization call. Any result other than “No Error” means the initialization failed for some reason.

	This returns a value of the enumerated type ProgramStatus.		This returns a value of the enumerated type ProgramStatus.

Admin at 00:07, 31 July 2015

2015-07-31T00:07:53Z

← Older revision		Revision as of 00:07, 31 July 2015
Line 1:		Line 1:
	{{~~MatchUpObjectIncrementalNav~~		{{MatchUpObjectHybridNav
	\|FunctionsCollapse=		\|FunctionsCollapse=
	}}		}}

Admin: Created page with "{{MatchUpObjectIncrementalNav |FunctionsCollapse= }} {{CustomTOC}} The following functions prepare the Hybrid interface for use and link it to its supporting data files. ==..."

2015-07-30T23:40:55Z

Created page with "{{MatchUpObjectIncrementalNav |FunctionsCollapse= }} {{CustomTOC}} The following functions prepare the Hybrid interface for use and link it to its supporting data files. ==..."

New page

{{MatchUpObjectIncrementalNav
|FunctionsCollapse=
}}

{{CustomTOC}}

The following functions prepare the Hybrid interface for use and link it to its supporting data files.

==SetPathToMatchUpFiles==
This function accepts a string value containing the path to the folder containing the MatchUp Hybrid data files.

This function must be called before calling the InitializeDataFiles function.

To provide maximum compatibility with Windows, three files are installed in your ‘Common App Data’ directory.
;Windows Vista and newer:
<pre>C:\ProgramData\MelissaDATA\MatchUp</pre>

;Windows XP:
<pre>C:\Documents and Settings\All Users\Application Data\Melissa DATA\MatchUp</pre>

The location of this directory can be changed by users so please note this, as it can often be the source of issues when running the samples/demos.

{{ Object Syntax
|Syntax=mdMU->SetPathToNameFiles(char)
|C=mdMUHybridSetPathToMatchUpFiles(mdMU, char)
|.Net=mdMU.PathToMatchUpFiles = string
}}

==SetLicenseString==
This function passes the license string required for MatchUp Object to function. A value of "1" is returned if the license string is valid, a vlue of "0" is returned for an invalid or empty string.

<span style="color:red;">This function is only required if the environment variable method is not used.</span>

Each customer is issued a license string when purchasing MatchUp Object or renewing a subscription. This string must be passed to this function to unlock the functionality of MatchUp Object.

The license string is normally set using an environment variable, either MD_LICENSE or MD_LICENSE_DEMO. Calling this function is an alternative method for setting the license string, but applications developed for a production environment should only use the environment variable.

When using an environment variable, it is not necessary to call this function.

For more information on setting the environment variable, see [[MatchUp Object:Licensing#Entering Your MatchUp Object License|Entering Your MatchUp Object License]].

{{ Object Syntax
|Syntax=int = mdMU->SetLicenseString(char)
|C=int = mdMUHybridSetLicenseString(mdMU, char)
|.Net=integer = mdMU.SetLicenseString string
}}

==SetMatchcodeName==
This function accepts a string value that must match the name of an existing matchcode in the current matchcode file.

{{ Object Syntax
|Syntax=mdMU->SetMatchcodeName(char)
|C=mdMUHybridMatchcodeName(mdMU, char)
|.Net=mdMU.MatchcodeName = string
}}

==SetMatchcodeObject==
This functions selects the matchcode to use for the current Hybrid deduping operation.

This function largely duplicates the purpose of the [[#SetMatchcodeName|SetMatchcodeName]] function, but instead of accepting a character value containing the name of a matchcode in the current matchcode file, this function accepts a Matchcode object created using the [[MatchUp Object:Matchcode Editor|Matchcode Editor]] interface.

Because this function requires the use of a separate interface to create the Matchcode object variable, it is normally simpler to use the [[#SetMatchcodeName|SetMatchcodeName]] function.

It is possible, however, to use this function to build a new matchcode on the fly using the [[MatchUp Object:Matchcode Editor|Matchcode Editor]] interface. Unless a specific application demands such flexibility, it is usually much simpler to add a new matchcode to the matchcode file and call it using the [[#SetMatchcodeName|SetMatchcodeName]] function.

{{ Object Syntax
|Syntax=mdMU->SetMatchcodeObject(mdMUMatchcode)
|C=mdMUHybridSetMatchcodeObject(mdMU, mdMUMatchcode)
|.Net=mdMU.MatchcodeObject = mdMUMatchcode
}}

==InitializeDataFiles==
This function opens the needed data files and prepares the MatchUp Object for use.

Before calling this function, the application must have successfully called the [[#SetLicenseString|SetLicenseString]] and [[#SetPathToMatchUpFiles|SetPathToMatchUpFiles]] functions.

Check the return value of the [[#GetInitializeErrorString|GetInitializeErrorString]] function to retrieve the result of the initialization call. Any result other than “ErrorNone” means the initialization failed for some reason.

This returns a value of the enumerated type ProgramStatus.

{|class="alternate01" cellspacing="0"
!Value!!Enumeration!!Description
|-
|0||ErrorNone||No error - Initialization was successful.
|-
|1||ErrorConfigFile||Could not find mdMatchUp.dat.
|-
|2||ErrorLicenseExpired||The License String has expired.
|-
|3||ErrorDatabaseExpired||The database has expired.
|-
|4||ErrorMatchcodeNotSpecified||No matchcode was specified.
|-
|5||ErrorMatchcodeNotFound||Specified Matchcode does not exist.
|-
|6||ErrorInvalidMatchcode||The specified matchcode is not valid.
|}

If any other value other than "ErrorNone" is returned, check the [[#GetInitializeErrorString|GetInitializeErrorString]] function to see the reason for the error.

{{ Object Syntax
|Syntax=ProgramStatus = mdMU->InitializeDataFiles()
|C=ProgramStatus = mdMUHybridInitializeDataFiles(mdMU)
|.Net=ProgramStatus = mdMU.InitializeDataFiles
}}

==GetInitializeErrorString==
This function returns a string to describe the error caused when the [[#InitializeDataFiles|InitializeDataFiles]] function cannot be successfully called.

The possible strings returned by this function are:

*"No error"
*"Could not find mdMatchUp.dat."
*"The License String has expired."
*"The database has expired."
*"No matchcode was specified."
*"Specified Matchcode does not exist."
*"The specified matchcode is not valid."
*"The specified key file was not found."

This function returns a string describing the error caused when the [[#InitializeDataFiles|InitializeDataFiles]] function cannot be called successfully.

{{ Object Syntax
|Syntax=char = mdMU->GetInitializeErrorString()
|C=char = mdMUHybridGetInitializeErrorString(mdMU)
|.Net=string = mdMU.GetInitializeErrorString
}}

==GetBuildNumber==
This function returns the current development release build number of MatchUp Object.

{{ Object Syntax
|Syntax=char = mdMU->GetBuildNumber()
|C=char = mdMUHybridGetBuildNumber(mdMU)
|.Net=string = mdMU.GetBuildNumber
}}

==GetDatabaseDate==
This function returns a string value that represents the revision date of the MatchUp Object data files.

{{ Object Syntax
|Syntax=char = mdMU->GetDatabaseDate()
|C=char = mdMUHybridGetDatabaseDate(mdMU)
|.Net=string = mdMU.GetDatabaseDate
}}

==GetDatabaseExpirationDate==
This function returns a string value containing the expiration date of the current database fil (mdMatchUp.dat).

{{ Object Syntax
|Syntax=char = mdMU->GetDatabaseExpirationDate()
|C=char = mdMUHybridGetDatabaseExpirationDate(mdMU)
|.Net=string = mdMU.GetDatabaseExpirationDate
}}

==GetLicenseExpirationDate==
This function returns a string value containing the expiration date of the current license string. After this date, MatchUp Object will no longer function.

{{ Object Syntax
|Syntax=char = mdMU->GetLicenseExpirationDate()
|C=char = mdMUHybridGetLicenseExpirationDate(mdMU)
|.Net=string = mdMU.GetLicenseExpirationDate
}}

[[Category:MatchUp Object]]