MatchUp Object:Incremental:Comparison

From Melissa Data Wiki
Jump to navigation Jump to search

← MatchUp Object Reference

MatchUp Object Incremental Interface Navigation
Order of Operations
Match Key
Key File

These functions compare the new key with the existing key file and, if a duplicate is found, return information about the duplicate records in the file.


This function compares the current match key to the keys in the key file and determines if this key matches a record that is already in the file.

If it is not a duplicate, a typical program would call the AddRecord function to add this key to the current key file.

If it is a duplicate, you can use the GetKey, GetCount, GetDupeGroup, GetResults, and GetEntry functions to gather information about the existing duplicate records in the file.

Syntax mdMU->MatchRecord()
C mdMUIncrementalMatchRecord(mdMU)
.Net mdMU.MatchRecord


This function is deprecated. You should use the GetResults function instead.


This function recalls the match data about the next record in the key file that matches the current search key.

After the MatchRecord function has detected a match between the input record, use this function to loop through all of the matching records in the key file, returning the match data for each record.

This function returns a true value if there is another matching record and false if there are no more matching records. This gives you the option of using a WHILE loop to repeatedly call the GetEntry, GetResults, GetDupeGroup, and GetKey functions for each matching record.

Syntax int = mdMU->NextMatchingRecord()
C int = mdMUIncrementalNextMatchingRecord(mdMU)
.Net integer mdMU.NextMatchingRecord


This function returns an integer value indicating the number of records in the key file that matched the current key.

If there were matches detected during a call to the MatchRecord function, this function will return a integer value equalling the number of duplicate keys found.

Syntax int = mdMU->GetCount()
C int = mdMUIncrementalGetCount(mdMU)
.Net integer = mdMU.GetCount


This function returns a long integer value indicating the group of duplicate records that the current key matches.

Every unique record (one with no duplicates) will have a unique “Dupe Group” number.

Any duplicate record will be assigned the same number. This function returns the Dupe Group number of a matching record in the key file.

Syntax long = mdMU->GetDupeGroup()
C long = mdMUIncrementalGetDupeGroup(mdMU)
.Net long = mdMU.GetDupeGroup


This function returns an integer value indicating where the current record falls within the order of its dupe group. For example, if this is the sixth matching record found, this function will return a "6".

Syntax int = mdMU->GetEntry()
C int = mdMUIncrementalGetEntry(mdMU)
.Net integer = mdMU.GetEntry


This function is deprecated. You should use the GetResults function instead.


This function returns the match key created by the last call to the BuildKey function and used by the last call to the MatchRecord function.

Syntax char = mdMU->GetKey()
C char = mdMUIncrementalGetKey(mdMU)
.Net string = mdMU.GetKey


This function returns the unique identifier associated with the record being checked by the Incremental interface. This is the same value passed to the SetUserInfo function.

The Incremental interface will need this information to match the current match key back to an original data source.

Syntax char = mdMU->GetUserInfo()
C char = mdMUIncrementalGetUserInfo(mdMU)
.Net string = mdMU.GetUserInfo


This function returns a comma-delimited string of four-character codes that detail the output disposition of the last call to the MatchRecord function. It will also contain the result code of any matchcode combination which contributed to the present record matching other records in its dupe group.

This function is intended to replace the GetStatusCode and GetCombinations functions, providing a single source of information about the last MatchRecord function call and eliminating the need to perform bitwise operations on the GetCombinations return value to determine which matchcode combinations contributed to the record matching other records in its Dupe Group.

The function returns one or more of the MatchUp Object Result Codes in a comma-delimited list.

Syntax StringValue = object->GetResults();
C StringValue = mdMatchUpGetResults(object);
.Net StringValue = object.GetResults