MatchUp Object:Read-Write:Initialization - Revision history

Admin at 21:47, 19 December 2016

2016-12-19T21:47:05Z

← Older revision		Revision as of 21:47, 19 December 2016
Line 28:		Line 28:

	==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 155:		Line 155:
	\|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 184:		Line 184:
	*"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 229:		Line 229:

	==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:45, 6 August 2015

2015-08-06T23:45:40Z

← Older revision		Revision as of 23:45, 6 August 2015
Line 100:		Line 100:
	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 function.		It must be called before calling the [[#InitializeDataFiles\|InitializeDataFiles]] function.

	The unique identifier set by [[MatchUp Object:Read-Write: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:Read-Write: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.

Admin at 23:37, 6 August 2015

2015-08-06T23:37:56Z

← Older revision		Revision as of 23:37, 6 August 2015
Line 25:		Line 25:
	\|.Net=mdMU.SetPathToMatchUpFiles = string		\|.Net=mdMU.SetPathToMatchUpFiles = string
	}}		}}


	==SetLicenseString==		==SetLicenseString==
Line 44:		Line 45:
	\|.Net=integer = mdMU.SetLicenseString string		\|.Net=integer = mdMU.SetLicenseString string
	}}		}}


	==SetMatchcodeName==		==SetMatchcodeName==
Line 53:		Line 55:
	\|.Net=mdMU.SetMatchcodeName = string		\|.Net=mdMU.SetMatchcodeName = string
	}}		}}


	==SetMatchcodeObject==		==SetMatchcodeObject==
Line 66:		Line 69:
	\|.Net=mdMU.SetMatchcodeObject = mdMUMatchcode		\|.Net=mdMU.SetMatchcodeObject = mdMUMatchcode
	}}		}}


	==SetKeyFile==		==SetKeyFile==
Line 77:		Line 81:
	\|.Net=mdMU.SetKeyFile = string		\|.Net=mdMU.SetKeyFile = string
	}}		}}


	==SetGroupSorting==		==SetGroupSorting==
Line 90:		Line 95:
	\|.Net=mdMU.SetGroupSorting		\|.Net=mdMU.SetGroupSorting
	}}		}}


	==SetReserved==		==SetReserved==
Line 103:		Line 109:
	\|.Net=mdMU.SetReserved(string)		\|.Net=mdMU.SetReserved(string)
	}}		}}


	==SetMaximumCharacterSize==		==SetMaximumCharacterSize==
	Optional. This function will accommodate UTF-8 input data. Since a single UTF-8 character can be up to 4 bytes long, the storage of the matchcode keys may need to be altered to accommodate this maximum size. However, if you are working in a part of the world where you are sure that a byte sequence will always be shorter, you can use this function to override the storage overhead.		Optional. This function will accommodate UTF-8 input data. Since a single UTF-8 character can be up to 4 bytes long, the storage of the matchcode keys may need to be altered to accommodate this maximum size. However, if you are working in a part of the world where you are sure that a byte sequence will always be shorter, you can use this function to override the storage overhead.

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

	Valid input values are 1, 2, 3 or 4. Invalid values will be ignored and the default size (e.g. if this function is not called) is 1.		Valid input values are 1, 2, 3 or 4. Invalid values will be ignored and the default size (e.g. if this function is not called) is 1.
Line 116:		Line 123:
	\|.Net=mdMU.SetMaximumCharacterSize(integer)		\|.Net=mdMU.SetMaximumCharacterSize(integer)
	}}		}}


	==SetEncoding==		==SetEncoding==
Line 131:		Line 139:
	\|.Net=mdMU.SetEncoding(string)		\|.Net=mdMU.SetEncoding(string)
	}}		}}


	==InitializeDataFiles==		==InitializeDataFiles==
Line 166:		Line 175:
	\|.Net=ProgramStatus = mdMU.InitializeDataFiles		\|.Net=ProgramStatus = mdMU.InitializeDataFiles
	}}		}}


	==GetInitializeErrorString==		==GetInitializeErrorString==
Line 186:		Line 196:
	\|.Net=string = mdMU.GetInitializeErrorString		\|.Net=string = mdMU.GetInitializeErrorString
	}}		}}


	==GetBuildNumber==		==GetBuildNumber==
Line 195:		Line 206:
	\|.Net=string = mdMU.GetBuildNumber		\|.Net=string = mdMU.GetBuildNumber
	}}		}}


	==GetDatabaseDate==		==GetDatabaseDate==
Line 204:		Line 216:
	\|.Net=string = mdMU.GetDatabaseDate		\|.Net=string = mdMU.GetDatabaseDate
	}}		}}


	==GetDatabaseExpirationDate==		==GetDatabaseExpirationDate==
Line 213:		Line 226:
	\|.Net=string = mdMU.GetDatabaseExpirationDate		\|.Net=string = mdMU.GetDatabaseExpirationDate
	}}		}}


	==GetLicenseExpirationDate==		==GetLicenseExpirationDate==

Admin at 23:02, 6 August 2015

2015-08-06T23:02:53Z

← Older revision		Revision as of 23:02, 6 August 2015
Line 23:		Line 23:
	\|Syntax=mdMU->SetPathToMatchUpFiles(char)		\|Syntax=mdMU->SetPathToMatchUpFiles(char)
	\|C=mdMUReadWriteSetPathToMatchUpFiles(mdMU, char)		\|C=mdMUReadWriteSetPathToMatchUpFiles(mdMU, char)
	\|.Net=mdMU.~~PathToMatchUpFiles~~ = string		\|.Net=mdMU.SetPathToMatchUpFiles = string
	}}		}}

Admin at 22:58, 6 August 2015

2015-08-06T22:58:16Z

@@ Line 50: / Line 50: @@
 {{ Object Syntax
 |Syntax=mdMU->SetMatchcodeName(char)
-|C=mdMUReadWriteMatchcodeName(mdMU, char)
+|C=mdMUReadWriteSetMatchcodeName(mdMU, char)
-|.Net=mdMU.MatchcodeName = string
+|.Net=mdMU.SetMatchcodeName = string
 }}
@@ Line 64: / Line 64: @@
 |Syntax=mdMU->SetMatchcodeObject(mdMUMatchcode)
 |C=mdMUReadWriteSetMatchcodeObject(mdMU, mdMUMatchcode)
-|.Net=mdMU.MatchcodeObject = mdMUMatchcode
+|.Net=mdMU.SetMatchcodeObject = mdMUMatchcode
 }}
@@ Line 75: / Line 75: @@
 |Syntax=mdMU->SetKeyFile(char)
 |C=mdMUReadWriteSetKeyFile(mdMU, char)
-|.Net=mdMU.KeyFile = string
+|.Net=mdMU.SetKeyFile = string
 }}
@@ Line 88: / Line 88: @@
 |Syntax=mdMU->SetGroupSorting()
 |C=mdMUReadWriteSetGroupSorting(mdMU)
-|.Net=mdMU.GroupSorting
+|.Net=mdMU.SetGroupSorting
 }}

Admin at 17:36, 31 July 2015

2015-07-31T17:36:48Z

← Older revision		Revision as of 17:36, 31 July 2015
Line 94:		Line 94:
	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.		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.		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:04, 30 July 2015

2015-07-30T23:04:30Z

← Older revision		Revision as of 23:04, 30 July 2015
Line 94:		Line 94:
	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.		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 ~~“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 118:		Line 118:
	\|}		\|}

	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 23:01, 30 July 2015

2015-07-30T23:01:02Z

← Older revision		Revision as of 23:01, 30 July 2015
Line 101:		Line 101:
	!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.

Admin at 21:53, 30 July 2015

2015-07-30T21:53:55Z

← Older revision		Revision as of 21:53, 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 at 20:22, 29 July 2015

2015-07-29T20:22:08Z

← Older revision		Revision as of 20:22, 29 July 2015
Line 5:		Line 5:
	{{CustomTOC}}		{{CustomTOC}}

	The following functions prepare the Read/Write ~~deduper~~ for use and link it to its		The following functions prepare the Read/Write interface for use and link it to its
	supporting data files.		supporting data files.