Admin at 21:47, 19 December 2016

2016-12-19T21:47:26Z

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

	==[[MatchUp Object:Matchcode:Initialization\|Initialize MatchUp Object]]==		==[[MatchUp Object:Matchcode:Initialization\|Initialize MatchUp Object]]==
	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.

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

Admin at 18:37, 31 July 2015

2015-07-31T18:37:45Z

← Older revision		Revision as of 18:37, 31 July 2015
Line 59:		Line 59:


	==[[MatchUp Object:Matchcode:~~Read~~ Information\|Read Matchcode Component Information]]==		==[[MatchUp Object:Matchcode:Component Information\|Read Matchcode Component Information]]==
	The functions in this section retrieve the number of components in a given matchcode and retrieve the contents of a specific matchcode component.		The functions in this section retrieve the number of components in a given matchcode and retrieve the contents of a specific matchcode component.

Line 65:		Line 65:
	!Function Name		!Function Name
	\|-		\|-
	\|[[MatchUp Object:Matchcode:~~Read~~ Information#GetMatchcodeItemCount\|GetMatchcodeItemCount]]		\|[[MatchUp Object:Matchcode:Component Information#GetMatchcodeItemCount\|GetMatchcodeItemCount]]
	\|-		\|-
	\|[[MatchUp Object:Matchcode:~~Read~~ Information#GetMatchcodeItem\|GetMatchcodeItem]]		\|[[MatchUp Object:Matchcode:Component Information#GetMatchcodeItem\|GetMatchcodeItem]]
	\|}		\|}

Admin at 18:44, 29 July 2015

2015-07-29T18:44:06Z

Show changes

Admin: Created page with "{{MatchUpObjectMatchcodeInterfaceNav |FunctionsCollapse= }} {{CustomTOC}} This is a master list of the functions in the Matchcode interface. ==[[MatchUp Object:Matchcode In..."

2015-07-29T16:58:38Z

Created page with "{{MatchUpObjectMatchcodeInterfaceNav |FunctionsCollapse= }} {{CustomTOC}} This is a master list of the functions in the Matchcode interface. ==[[MatchUp Object:Matchcode In..."

New page

{{MatchUpObjectMatchcodeInterfaceNav
|FunctionsCollapse=
}}

{{CustomTOC}}

This is a master list of the functions in the Matchcode interface.

==[[MatchUp Object:Matchcode Interface:Initialization|Initialize MatchUp Object]]==
Initializing the Matchcode interface is simpler than the other interfaces, since no license string is required.

{|class="alternate01 sortable" cellspacing="0"
!Function Name
|-
|[[MatchUp Object:Matchcode Interface:Initialization#SetPathToMatchUpFiles|SetPathToMatchUpFiles]]
|-
|[[MatchUp Object:Matchcode Interface:Initialization#InitializeDataFiles|InitializeDataFiles]]
|-
|[[MatchUp Object:Matchcode Interface:Initialization#GetInitializeErrorString|GetInitializeErrorString]]
|}

==[[MatchUp Object:Matchcode Interface:Create|Create a New Matchcode]]==
This function is part of the Matchcode class and creates a new, blank matchcode that can be populated with matchcode components and saved to the current matchcode file.

{|class="alternate01 sortable" cellspacing="0"
!Function Name
|-
|[[MatchUp Object:Matchcode Interface:Create#CreateNewMatchcode|CreateNewMatchcode]]
|}

==[[MatchUp Object:Matchcode Interface:Retrieval|Retrieve Existing Matchcodes]]==
These functions are used to retrieve a specific matchcode from the matchcode file.

{|class="alternate01 sortable" cellspacing="0"
!Function Name
|-
|[[MatchUp Object:Matchcode Interface:Retrieval#FindMatchcode|FindMatchcode]]
|-
|[[MatchUp Object:Matchcode Interface:Retrieval#GetMatchcodeName|GetMatchcodeName]]
|}

==[[MatchUp Object:Matchcode Interface:Properties|General Matchcode Properties]]==
These functions help with defining various Matchcode properties.

{|class="alternate01 sortable" cellspacing="0"
!Function Name
|-
|[[MatchUp Object:Matchcode Interface:Properties#GetDescription|GetDescription]]
|-
|[[MatchUp Object:Matchcode Interface:Properties#SetDescription|SetDescription]]
|-
|[[MatchUp Object:Matchcode Interface:Properties#GetNGram|GetNGram]]
|-
|[[MatchUp Object:Matchcode Interface:Properties#SetNGram|SetNGram]]
|}

==[[MatchUp Object:Matchcode Interface:Read Information|Read Matchcode Component Information]]==
The functions in this section retrieve the number of components in a given matchcode and retrieve the contents of a specific matchcode component.

{|class="alternate01 sortable" cellspacing="0"
!Function Name
|-
|[[MatchUp Object:Matchcode Interface:Read Information#GetMatchcodeItemCount|GetMatchcodeItemCount]]
|-
|[[MatchUp Object:Matchcode Interface:Read Information#GetMatchcodeItem|GetMatchcodeItem]]
|}

==[[MatchUp Object:Matchcode Interface:Mapping|Get Mapping Information]]==
Mapping information is different from component information, revealing the order and mapping types that should be used when creating the mappings in any one of the interfaces.

{|class="alternate01 sortable" cellspacing="0"
!Function Name
|-
|[[MatchUp Object:Matchcode Interface:Mapping#GetMappingItemCount|GetMappingItemCount]]
|-
|[[MatchUp Object:Matchcode Interface:Mapping#GetMappingItemType|GetMappingItemType]]
|-
|[[MatchUp Object:Matchcode Interface:Mapping#GetMappingItemLabel|GetMappingItemLabel]]
|}

==[[MatchUp Object:Matchcode Interface:Change Settings|Change Matchcode Component Settings]]==
These functions set the values for the various settings of a matchcode component object. They can be used to construct new matchcode components when adding them to a matchcode or to change the settings of an existing component. Every function in this section requires a variable based on the mdMatchcodeComponent class.

{|class="alternate01 sortable" cellspacing="0"
!Function Name
|-
|[[MatchUp Object:Matchcode Interface:Change Settings#SetComponentType|SetComponentType]]
|-
|[[MatchUp Object:Matchcode Interface:Change Settings#SetSize|SetSize]]
|-
|[[MatchUp Object:Matchcode Interface:Change Settings#SetLabel|SetLabel]]
|-
|[[MatchUp Object:Matchcode Interface:Change Settings#SetWordCount|SetWordCount]]
|-
|[[MatchUp Object:Matchcode Interface:Change Settings#SetStart|SetStart]]
|-
|[[MatchUp Object:Matchcode Interface:Change Settings#SetStartPos|SetStartPos]]
|-
|[[MatchUp Object:Matchcode Interface:Change Settings#SetTrim|SetTrim]]
|-
|[[MatchUp Object:Matchcode Interface:Change Settings#SetFuzzy|SetFuzzy]]
|-
|[[MatchUp Object:Matchcode Interface:Change Settings#SetNear|SetNear]]
|-
|[[MatchUp Object:Matchcode Interface:Change Settings#SetNearDbl|SetNearDbl]]
|-
|[[MatchUp Object:Matchcode Interface:Change Settings#SetFieldMatch|SetFieldMatch]]
|-
|[[MatchUp Object:Matchcode Interface:Change Settings#SetCombination|SetCombination]]
|-
|[[MatchUp Object:Matchcode Interface:Change Settings#SetSwap|SetSwap]]
|}

==[[MatchUp Object:Matchcode Interface:Read Settings|Read Matchcode Component Settings]]==
These functions read and return the settings from a specific matchcode component variable.

{|class="alternate01 sortable" cellspacing="0"
!Function Name
|-
|[[MatchUp Object:Matchcode Interface:Read Settings#GetComponentType|GetComponentType]]
|-
|[[MatchUp Object:Matchcode Interface:Read Settings#GetSize|GetSize]]
|-
|[[MatchUp Object:Matchcode Interface:Read Settings#GetLabel|GetLabel]]
|-
|[[MatchUp Object:Matchcode Interface:Read Settings#GetWordCount|GetWordCount]]
|-
|[[MatchUp Object:Matchcode Interface:Read Settings#GetStart|GetStart]]
|-
|[[MatchUp Object:Matchcode Interface:Read Settings#GetStartPos|GetStartPos]]
|-
|[[MatchUp Object:Matchcode Interface:Read Settings#GetTrim|GetTrim]]
|-
|[[MatchUp Object:Matchcode Interface:Read Settings#GetFuzzy|GetFuzzy]]
|-
|[[MatchUp Object:Matchcode Interface:Read Settings#GetNear|GetNear]]
|-
|[[MatchUp Object:Matchcode Interface:Read Settings#GetNearDbl|GetNearDbl]]
|-
|[[MatchUp Object:Matchcode Interface:Read Settings#GetFieldMatch|GetFieldMatch]]
|-
|[[MatchUp Object:Matchcode Interface:Read Settings#GetCombination|GetCombination]]
|-
|[[MatchUp Object:Matchcode Interface:Read Settings#GetSwap|GetSwap]]
|}

==[[MatchUp Object:Matchcode Interface:Modify|Add, Modify or Delete Matchcode Components]]==
These functions add, insert, update, or delete matchcode components from the current Matchcode object.

{|class="alternate01 sortable" cellspacing="0"
!Function Name
|-
|[[MatchUp Object:Matchcode Interface:Modify#AddMatchcodeItem|AddMatchcodeItem]]
|-
|[[MatchUp Object:Matchcode Interface:Modify#InsertMatchcodeItem|InsertMatchcodeItem]]
|-
|[[MatchUp Object:Matchcode Interface:Modify#ChangeMatchcodeItem|ChangeMatchcodeItem]]
|-
|[[MatchUp Object:Matchcode Interface:Modify#DeleteMatchcodeItem|DeleteMatchcodeItem]]
|}

==[[MatchUp Object:Matchcode Interface:Save|Save Changes to the Matchcode File]]==
These functions save changes to the current matchcode file, either back to the original default file or to a new file.

{|class="alternate01 sortable" cellspacing="0"
!Function Name
|-
|[[MatchUp Object:Matchcode Interface:Save#Save|Save]]
|-
|[[MatchUp Object:Matchcode Interface:Save#SaveToFile|SaveToFile]]
|-
|[[MatchUp Object:Matchcode Interface:Save#RenameMatchcode|RenameMatchcode]]
|-
|[[MatchUp Object:Matchcode Interface:Save#DeleteMatchcode|DeleteMatchcode]]
|}

[[Category:MatchUp Object]]

MatchUp Object:Matchcode:Functions - Revision history

Admin at 21:47, 19 December 2016

Admin at 18:37, 31 July 2015

Admin at 18:44, 29 July 2015

Admin: Created page with "{{MatchUpObjectMatchcodeInterfaceNav |FunctionsCollapse= }} {{CustomTOC}} This is a master list of the functions in the Matchcode interface. ==[[MatchUp Object:Matchcode In..."