MatchUp Object:Matchcode:Read Settings

← MatchUp Object Reference

The following functions read and return the settings from a specific matchcode component variable.

GetComponentType

This function returns the component type of the current MatchcodeComponent object.

The return value for this function is an enumerated value of the type MatchcodeComponentType.

For a list of these enumerations, see Matchcode Component Type Enumerations.

Syntax	MatchcodeComponentType = mdMCC->GetComponentType()
C	mdMUMatchcodeComponentType=mdMUMatchcodeComponentGetComponentType(mdMCC)
.Net	MatchcodeComponentType = mdMCC.GetComponentType

GetSize

This function returns how many characters from the source data will be used by the current MatchcodeComponent.

This integer value shows the number of characters that this component will use from the related field from each record. If the field is longer than this value, the data will be truncated. If the field is shorter, it will be padded with spaces.

Size is only applied to a piece of data after all other component properties have been considered.

Syntax	int = mdMCC->GetSize()
C	int = mdMUMatchcodeComponentGetSize(mdMCC)
.Net	integer = mdMCC.GetSize

GetLabel

This function returns the label, if any, of the current MatchcodeComponent object.

Not all components accept a label. For example, none of the street address components (Street number, street name, and so on) use a label because they are not used for mapping.

Components that are not assigned a label will return the name of their component type.

Syntax	char = mdMCC->GetLabel()
C	char = mdMUMatchcodeComponentGetLabel(mdMCC)
.Net	string = mdMCC.GetLabel

GetWordCount

This function returns the maximum number of words used by the current MatchcodeComponent object.

The maximum number of words offers further control over the amount of data used by each component. If this function is set to 1, then MatchUp Object will take every character up to, but not including, the first space.

If the first word is shorter than the value passed to the SetSize function, then the data will still be truncated at that character, regardless of the setting returned by this function.

Syntax	int = mdMCC->GetWordCount()
C	int = mdMUMatchcodeComponentGetWordCount(mdMCC)
.Net	integer = mdMCC.GetWordCount

GetStart

This function returns an enumerated value of the type MatchcodeStart that shows where MatchUp Object starts counting when applying the component size.

For a list of these enumerations, see MatchcodeStart Enumerations.

If the selected value is either StartAtPos or StartAtWord, the application will need to call the GetStartPos function to discover what starting word or character position is being used.

Syntax	MatchcodeStart = mdMCC->GetStart()
C	mdMUMatchcodeStart= mdMUMatchcodeComponentGetStart(mdMCC)
.Net	MatchcodeStart = mdMCC.GetStart

GetStartPos

This functions returns the specific character position or word used as the starting point, when the SetStart function is set to Position or Word.

It will return an integer value when the SetStart function has been set to either StartAtPos or StartAtWord.

It returns either the character position or the word where MatchUp Object starts counting when adding a field to a match key.

Syntax	int = mdMCC->GetStartPos()
C	int = mdMUMatchcodeComponentGetStartPos(mdMCC)
.Net	integer = mdMCC.GetStartPos

GetTrim

This function returns an enumerated value of the type MatchcodeTrim, showing whether the current matchcode will trim beginning or ending spaces from the data before performing other operations upon it.

For a list of these enumerations, see MatchcodeTrim Enumerations.

For most applications, this function will return the value AllTrim, which trims excess blank spaces from both the start and end of a field before adding to a match key.

Syntax	MatchcodeTrim = mdMCC->GetTrim()
C	mdMUMatchcodeTrim = mdMUMatchcodeComponentGetTrim(mdMCC)
.Net	MatchcodeTrim = mdMCC.GetTrim

GetFuzzy

This function returns an enumerated value of the type MatchcodeFuzzy used when comparing this MatchcodeComponent.

For a list of these enumerations, see MatchcodeFuzzy Enumerations.

For more information, see Matchcode Component Properties.

Syntax	MatchcodeFuzzy = mdMCC->GetFuzzy()
C	mdMUMatchcodeFuzzy = mdMUMatchcodeComponentGetFuzzy(mdMCC)
.Net	MatchcodeFuzzy = mdMCC.GetFuzzy

GetNear

This function returns the degree of precision used when the SetFuzzy function is set to Fast Near, Accurate Near, or Frequency Near.

The integer value from 1 to 4 shows how many differences are allowed before two keys are no longer considered a match when one of the Near matching strategies is selected with the SetFuzzy function.

Syntax	int mdMCC->GetNear()
C	int = mdMUMatchcodeComponentGetNear(mdMCC)
.Net	integer = mdMCC.GetNear

GetNearDbl

This function returns the minimum percentage of similarity which will return a match between two strings when the SetFuzzy function is set to Proximity, N-Gram, Jaro, Jaro Winkler, LCS, Needleman, MDKeyboard, Smith Waterman, Dice's Coefficient, Jaccard, Overlap Coefficient, or DoubleMetaphone algorithm.

The double value from 100 to 0 shows the minimum threshold percent similarity between two keys which will be considered a match when one of the NearDbl matching strategies is selected with the SetFuzzy function.

Syntax	double = mdMCC->GetNearDbl()
C	double = mdMUMatchcodeComponentGetNearDbl(mdMUMatchcodeComponent)
.Net	double = mdMCC.GetNearDbl

GetFieldMatch

This function returns an enumerated value of the type MatchcodeFieldMatch, which determines how MatchUp Object handles blank or partial fields when applying a matchcode.

For a list of these enumerations, see MatchcodeFieldMatch Enumerations.

These selections are not mutually exclusive. In order to determine which settings are being used, you will need to use a logical AND operation to check the return value against each of the above values.

Some languages, such as C++, do not easily handle using logical operation on enumerations. In these cases, it may be necessary to cast the return values as an integer before using the AND operation to check the values.

For more information, see Blank Field Matching.

Syntax	MatchcodeFieldMatch = mdMCC->GetFieldMatch()
C	mdMUMatchcodeFieldMatch = mdMUMatchcodeComponentGetFieldMatch(mdMCC)
.Net	MatchcodeFieldMatch = mdMCC.GetFieldMatch

GetCombination

This function shows which combinations in the current matchcode will use this component. It returns an enumerated value of the type MatchcodeCombination.

For a list of these enumerations, see MatchcodeCombination Enumerations.

These selections are not mutually exclusive. In order to determine which settings are being used, you will need to use a logical AND operation to check the return value against each of the above values.

Some languages, such as C++, do not easily handle using logical operation on enumerations. In these cases, it may be necessary to cast the return values as an integer before using the AND operation to check the values.

Syntax	MatchcodeCombination = mdMCC->GetCombination()
C	mdMUMatchcodeCombination = mdMUMatchcodeComponentGetCombination(mdMCC)
.Net	MatchcodeCombination = mdMCC.GetCombination

GetSwap

This function shows which swap pairs in the current matchcode will use this component. It accepts an enumerated value of the type MatchcodeSwap.

For a list of these enumerations, see MatchcodeSwap Enumerations.

These selections are not mutually exclusive. In order to determine which settings are being used, you will need to use a logical AND operation to check the return value against each of the above values.

Some languages, such as C++, do not easily handle using logical operation on enumerations. In these cases, it may be necessary to cast the return values as an integer before using the AND operation to check the values.

Syntax	MatchcodeSwap = mdMCC->GetSwap()
C	mdMUMatchcodeSwap = mdMUMatchcodeComponentGetMatchcodeSwap(mdMCC)
.Net	MatchcodeSwap = mdMCC.GetSwap