MatchUp Object:Matchcode:Properties

← MatchUp Object Reference

These functions help with defining various Matchcode properties.

GetDescription

This function retrieves a matchcode’s user-specified description associated with this matchcode.

Syntax	StringValue =mdMC->GetDescription()
C	StringValue = mdMUMatchcodeGetDescription(mdMUMatchcode)
.Net	StringValue = mdMC.GetDescription

SetDescription

This function allows you to assign a description to the matchcode.

For example, it may describe what the matchcode evaluates or the type of process the matchcode is used in. When viewing the matchcode in the matchcode editor, the description will be present along with the actual properties of the matchcode.

Syntax	mdMC->SetDescription(StringValue)
C	mdMUMatchcodeSetDescription(mdMUMatchcode, StringValue)
.Net	mdMC.SetDescription = StringValue

GetNGram

This function retrieves a matchcode’s N-gram setting.

Since a matchcode may contain multiple components each using a different fuzzy algorithm, many of which require an N-gram setting, the N-gram setting is applied to all relevant components. In other words, the N-gram is set at the matchcode level, not the component level.

Syntax	integer = mdMC->GetNGram()
C	integer = mdMUMatchcodeGetNGram(mdMUMatchcode)
.Net	integer = mdMC.GetNGram

SetNGram

Sets a matchcode’s N-gram setting.

Since a matchcode may contain multiple components each using a different fuzzy algorithm, many of which require an N-gram setting, the N-gram setting is applied to all relevant components. In other words, the N-gram is set at the matchcode level, not the component level.

Syntax	mdMC->SetNGram(integer)
C	mdMUMatchcodeSetNGram(mdMUMatchcode, integer)
.Net	mdMC.SetNGram = integer