MatchUp Object:Incremental:Initialization - Revision history

Admin at 21:54, 19 December 2016

2016-12-19T21:54:52Z

← Older revision		Revision as of 21:54, 19 December 2016
Line 27:		Line 27:

	==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 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 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 161:		Line 161:
	\|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 190:		Line 190:
	*"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 235:		Line 235:

	==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 16:56, 28 October 2015

2015-10-28T16:56:06Z

← Older revision		Revision as of 16:56, 28 October 2015
Line 100:		Line 100:


	==SetReserved==		==SetReserved <span style="color:red;">(Deprecated)</span>==

	Optional. This function accepts two parameters: A string parameter containing the property to be set; and a string parameter representing the value for the property being set.		Optional. This function accepts two parameters: A string parameter containing the property to be set; and a string parameter representing the value for the property being set.

	It must be called before calling the [[#InitializeDataFiles\|InitializeDataFiles]] function.		It must be called before calling the [[#InitializeDataFiles\|InitializeDataFiles]] function.

	The unique identifier set by [[MatchUp Object:Incremental:Match Key#SetUserInfo\|SetUserInfo]] and attached to built match keys is 1024 bytes by default. ~~This lets you pass an advanced custom identifier or even source data to~~ the ~~key file. This can have data handling advantages but will slow down the process because the key file~~ and ~~temporary sort files~~ will ~~grow much larger than needed for most jobs~~. ~~This function property has been added, allowing you to override the default UserInfo to a more efficient size~~.		The unique identifier set by [[MatchUp Object:Incremental:Match Key#SetUserInfo\|SetUserInfo]] and attached to built match keys is 1024 bytes by default. Overriding this size with SetReserved(“UserInfosize”,”size”) is deprecated for the Incremental interface and a call to this method will be ignored. Newer Incremental key storage mechanisms have made this parameter obsolete.

	{{ Object Syntax		{{ Object Syntax

Admin at 23:47, 6 August 2015

2015-08-06T23:47:00Z

@@ Line 22: / Line 22: @@
 |Syntax=mdMU->SetPathToMatchUpFiles(char)
 |C=mdMUIncrementalSetPathToMatchUpFiles(mdMU, char)
-|.Net=mdMU.PathToMatchUpFiles = string
+|.Net=mdMU.SetPathToMatchUpFiles = string
 }}
@@ Line 52: / Line 52: @@
 |Syntax=mdMU->SetMatchcodeName(char)
 |C=mdMUIncrementalSetMatchcodeName(mdMU, char)
-|.Net=mdMU.MatchcodeName = string
+|.Net=mdMU.SetMatchcodeName = string
 }}
@@ Line 68: / Line 68: @@
 |Syntax=mdMU->SetMatchcodeObject(mdMUMatchcode)
 |C=mdMUIncrementalSetMatchcodeObject(mdMU, mdMUMatchcode)
-|.Net=mdMU.MatchcodeObject = mdMUMatchcode
+|.Net=mdMU.SetMatchcodeObject = mdMUMatchcode
 }}
@@ Line 82: / Line 82: @@
 |Syntax=mdMU->SetMustExist(bool)
 |C=mdMUIncrementalSetMustExist(mdMU, bool)
-|.Net=mdMU.MustExist = boolean
+|.Net=mdMU.SetMustExist = boolean
 }}
@@ Line 96: / Line 96: @@
 |Syntax=mdMU->SetKeyFile(char)
 |C=mdMUIncrementalSetKeyFile(mdMU, char)
-|.Net=mdMU.KeyFile = string
+|.Net=mdMU.SetKeyFile = string
 }}

Admin at 17:38, 31 July 2015

2015-07-31T17:38:01Z

← Older revision		Revision as of 17:38, 31 July 2015
Line 105:		Line 105:
	Before calling this function, the code must have successfully called the [[#SetLicenseString\|SetLicenseString]], [[#SetMatchcodeName\|SetMatchcodeName]] (or [[#SetMatchcodeObject\|SetMatchcodeObject]]) and [[#SetPathToMatchUpFiles\|SetPathToMatchUpFiles]] functions.		Before calling this function, the code must have successfully called the [[#SetLicenseString\|SetLicenseString]], [[#SetMatchcodeName\|SetMatchcodeName]] (or [[#SetMatchcodeObject\|SetMatchcodeObject]]) 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.

	{\|class="alternate01" cellspacing="0"		{\|class="alternate01" cellspacing="0"

Admin at 23:11, 30 July 2015

2015-07-30T23:11:58Z

← Older revision		Revision as of 23:11, 30 July 2015
Line 105:		Line 105:
	Before calling this function, the code must have successfully called the [[#SetLicenseString\|SetLicenseString]], [[#SetMatchcodeName\|SetMatchcodeName]] (or [[#SetMatchcodeObject\|SetMatchcodeObject]]) and [[#SetPathToMatchUpFiles\|SetPathToMatchUpFiles]] functions.		Before calling this function, the code must have successfully called the [[#SetLicenseString\|SetLicenseString]], [[#SetMatchcodeName\|SetMatchcodeName]] (or [[#SetMatchcodeObject\|SetMatchcodeObject]]) 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 ~~“No Error”~~ 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 “ErrorNone” 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
Line 112:		Line 112:
	!Value!!Enumeration!!Description		!Value!!Enumeration!!Description
	\|-		\|-
	\|0\|\|ErrorNone No error~~\|\|initialization~~ was successful.		\|0\|\|ErrorNone\|\|No error - Initialization was successful.
	\|-		\|-
	\|1\|\|ErrorConfigFile\|\|Could not find mdMatchUp.dat.		\|1\|\|ErrorConfigFile\|\|Could not find mdMatchUp.dat.
Line 129:		Line 129:
	\|}		\|}

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

	{{ Object Syntax		{{ Object Syntax

Admin at 21:54, 30 July 2015

2015-07-30T21:54:30Z

← Older revision		Revision as of 21:54, 30 July 2015
Line 33:		Line 33:
	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 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 ~~'''SetLicenseString'''~~ is an alternative method for setting the license string, but applications developed for a production environment should only use the environment variable.		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 ~~the '''SetLicenseString'''~~ 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\|Entering Your MatchUp Object License]].

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

2015-07-29T21:49:50Z

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

New page

{{MatchUpObjectIncrementalNav
|FunctionsCollapse=
}}

{{CustomTOC}}

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

==SetPathToMatchUpFiles==
String value. This function accepts a string value containing the path to the folder containing the MatchUp data files. It must be called before calling the [[#InitializeDataFiles|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->SetPathToMatchUpFiles(char)
|C=mdMUIncrementalSetPathToMatchUpFiles(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 '''SetLicenseString''' 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 the '''SetLicenseString''' 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 = mdMUIncrementalSetLicenseString(mdMU, char)
|.Net=integer = mdMU.SetLicenseString string
}}

==SetMatchcodeName==
This function selects the matchcode to use for the current Incremental deduping operation. It 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=mdMUIncrementalSetMatchcodeName(mdMU, char)
|.Net=mdMU.MatchcodeName = string
}}

==SetMatchcodeObject==
This function selects the matchcode to use for the current Incremental 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 Matchcode Editing interface.

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

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

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

==SetMustExist==
This function determines whether or not the path specified by the [[#SetKeyFile|SetKeyFile]] function must point to an existing key file.

If this option is set to true, initialization of MatchUp Object will fail if the path specified in the [[#SetKeyFile|SetKeyFile]] function does not point to an existing key file.

If this option is false, and the path specified in the [[#SetKeyFile|SetKeyFile]] function does not point to an existing key file, a new empty key file will be created.

{{ Object Syntax
|Syntax=mdMU->SetMustExist(bool)
|C=mdMUIncrementalSetMustExist(mdMU, bool)
|.Net=mdMU.MustExist = boolean
}}

==SetKeyFile==
This function selects the name and file path for the key file that will be used for the current Incremental deduping operation.

If the [[#SetMustExist|SetMustExist]] function has been set to True, the string value passed to this function must contain a valid path to an existing key file.

If the [[#SetMustExist|SetMustExist]] function has been set to False, MatchUp Object will create an empty key file if none is found during initialization.

{{ Object Syntax
|Syntax=mdMU->SetKeyFile(char)
|C=mdMUIncrementalSetKeyFile(mdMU, char)
|.Net=mdMU.KeyFile = string
}}

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

Before calling this function, the code must have successfully called the [[#SetLicenseString|SetLicenseString]], [[#SetMatchcodeName|SetMatchcodeName]] (or [[#SetMatchcodeObject|SetMatchcodeObject]]) 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 “No Error” 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.
|-
|7||ErrorKeyFile||The specified key file was not found.
|}

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

{{ Object Syntax
|Syntax=ProgramStatus = mdMU->InitializeDataFiles()
|C=ProgramStatus = mdMUIncrementalInitializeDataFiles(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."

{{ Object Syntax
|Syntax=char = mdMU->GetInitializeErrorString()
|C=char = mdMUIncrementalGetInitializeErrorString(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 = mdMUIncrementalGetBuildNumber(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 = mdMUIncrementalGetDatabaseDate(mdMU)
|.Net=string = mdMU.GetDatabaseDate
}}

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

{{ Object Syntax
|Syntax=char = mdMU->GetDatabaseExpirationDate()
|C=char = mdMUIncrementalGetDatabaseExpirationDate(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 = mdMUIncrementalGetLicenseExpirationDate(mdMU)
|.Net=string = mdMU.GetLicenseExpirationDate
}}

[[Category:MatchUp Object]]