MatchUp Object:Read-Write:Retrieval

← MatchUp Object Reference

The functions in this section cycle through each record processed and return output unique/duplicate information.

ReadRecord

This function reads the next record from the key file, if there is another record, and populates the fields used by the following functions:

• GetResults
• GetCount
• GetDupeGroup
• GetEntry
• GetKey
• GetUserInfo.

This function cannot be called until after the application has called the Process function.

If there are no more records, this returns an integer value of zero.

Syntax	int = mdMU->ReadRecord()
C	int = mdMUReadWriteReadRecord(mdMU)
.Net	integer = mdMU.ReadRecord

GetStatusCode

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

GetCount

If there were matches detected during processing, this function will return an integer value indicating the total number of matching records in this dupe group.

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

GetDupeGroup

Every unique record (one with no duplicates) will have a unique “Dupe Group” number. Any duplicate record will be assigned this same number. This function returns the Dupe Group number (a long integer value) of a matching record in the key file.

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

GetEntry

If the ReadRecord function detected at least one duplicate, this function will return an integer value that indicates where the current record falls within 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 = mdMUReadWriteGetEntry(mdMU)
.Net	integer = mdMU.Entry

GetCombinations

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

Each matchcode may contain as many as 16 different combinations of data types that may be used to detect a match. A matching record may match more than one combination. This function returns a long integer value that can be used to determine which combination produced the match, if the ReadRecord function detected a matching key.

Syntax	long = mdMU->GetCombinations()
C	long = mdMUReadWriteGetCombinations(mdMU)
.Net	long = mdMU.Combinations

GetKey

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

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

GetUserInfo

This function returns a character value containing the value passed to the SetUserInfo function. It returns the unique identifier associated with the record being checked by the Read-Write interface.

The application will need this information if the application has to match the current matchkey back to an original data source.

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

GetResults

This function returns a comma-delimited string of four-character codes that detail the output disposition of the last call to the ReadRecord 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.Results