Admin at 22:01, 19 December 2016

2016-12-19T22:01:39Z

← Older revision		Revision as of 22:01, 19 December 2016
Line 5:		Line 5:
	{{CustomTOC}}		{{CustomTOC}}

	Initializing the Matchcode interface is simpler than the other interfaces, since no ~~license string~~ is required.		Initializing the Matchcode interface is simpler than the other interfaces, since no License Key is required.

	==SetPathToMatchUpFiles==		==SetPathToMatchUpFiles==

Admin at 18:41, 7 August 2015

2015-08-07T18:41:41Z

← Older revision		Revision as of 18:41, 7 August 2015
Line 24:		Line 24:
	\|Syntax=mdMC->SetPathToMatchUpFiles(char)		\|Syntax=mdMC->SetPathToMatchUpFiles(char)
	\|C=mdMUMatchcodeSetPathToMatchUpFiles(mdMC, char)		\|C=mdMUMatchcodeSetPathToMatchUpFiles(mdMC, char)
	\|.Net=mdMC.~~PathToMatchUpFiles~~ = string		\|.Net=mdMC.SetPathToMatchUpFiles = string
	}}		}}

Admin: Created page with "{{MatchUpObjectMatchcodeInterfaceNav |FunctionsCollapse= }} {{CustomTOC}} Initializing the Matchcode interface is simpler than the other interfaces, since no license string ..."

2015-07-31T17:43:43Z

Created page with "{{MatchUpObjectMatchcodeInterfaceNav |FunctionsCollapse= }} {{CustomTOC}} Initializing the Matchcode interface is simpler than the other interfaces, since no license string ..."

New page

{{MatchUpObjectMatchcodeInterfaceNav
|FunctionsCollapse=
}}

{{CustomTOC}}

Initializing the Matchcode interface is simpler than the other interfaces, since no license string is required.

==SetPathToMatchUpFiles==
This function accepts a string value indicating the file path to the folder containing the MatchUp Object files.

This function 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=mdMC->SetPathToMatchUpFiles(char)
|C=mdMUMatchcodeSetPathToMatchUpFiles(mdMC, char)
|.Net=mdMC.PathToMatchUpFiles = string
}}

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

Before calling this function, you must have successfully called [[#SetPathToMatchUpFiles|SetPathToMatchUpFiles]] function.

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.
|-
|5||ErrorMatchcodeNotFound||Specified Matchcode does not exist.
|}

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 = mdMC->InitializeDataFiles()
|C=ProgramStatus = mdMUMatchcodeInitializeDataFiles(mdMC)
|.Net=ProgramStatus = mdMC.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 method are:
*"No Error"
*"Could not open mdName.dat"
*"Matchcode not found"

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

[[Category:MatchUp Object]]

MatchUp Object:Matchcode:Initialization - Revision history

Admin at 22:01, 19 December 2016

Admin at 18:41, 7 August 2015

Admin: Created page with "{{MatchUpObjectMatchcodeInterfaceNav |FunctionsCollapse= }} {{CustomTOC}} Initializing the Matchcode interface is simpler than the other interfaces, since no license string ..."