Profiler Object:Column-Based Value SoundEx Table Iteration

← Profiler Object Reference

These functions allow you to step through each distinct SoundEx pattern for a specific column.

StartSoundExFrequency

This function initiates the iterator. It returns 1 to indicate if there are records to iterate through. Otherwise it returns 0.

This function takes two parameters.

Parameters

Name	Data Type	Description
ColumnName	String	Column Name to start the iterator.
Order	Order	This specifies how to order. See Order Enumeration for details.

Syntax	int = profiler->StartSoundExFrequency(columnNameStr, Order);
C	int = mdProfilerStartSoundExFrequency(profiler,columnNameStr, Order);
.Net	integer = profiler.StartSoundExFrequency(columnNameStr, Order);

GetSoundExFrequencyValue

This function returns a column's distinct SoundEx pattern.

This function takes one parameter.

Parameters

Name	Data Type	Description
ColumnName	String	Column Name to get the column’s distinct SoundEx pattern.

Syntax	profiler->GetSoundExFrequencyValue(columnNameStr);
C	const char* = mdProfilerGetSoundExFrequencyValue(profiler,columnNameStr);
.Net	string = profiler.GetSoundExFrequencyValue(columnNameStr);

GetSoundExFrequencyExample

This function returns an example value represented by the pattern. This will always be the first value encountered while profiling.

This function takes one parameter.

Parameters

Name	Data Type	Description
ColumnName	String	Column Name to get an example value represented by the pattern.

Syntax	profiler->GetSoundExFrequencyExample(columnNameStr);
C	const char* = mdProfilerGetSoundExFrequencyExample(profiler,columnNameStr);
.Net	string = profiler.GetSoundExFrequencyExample(columnNameStr);

GetSoundExFrequencyCount

This function returns the number of times the patterns appears in the profiled data for this particular column.

This function takes one parameter.

Parameters

Name	Data Type	Description
ColumnName	String	Column Name to get the number of times the pattern appears in the profiled data.

Syntax	profiler->GetSoundExFrequencyCount(columnNameStr);
C	integer = mdProfilerGetSoundExFrequencyCount(profiler,columnNameStr);
.Net	integer = profiler.GetSoundExFrequencyCount(columnNameStr);

GetNextSoundExFrequency

This function steps to the next distinct pattern. It returns 1 if there are more distinct patterns or 0 when there are no more patterns.

This function takes one parameter.

Parameters

Name	Data Type	Description
ColumnName	String	Column Name to get the next distinct pattern.

Syntax	profiler->GetNextSoundExFrequency(columnNameStr);
C	integer = mdProfilerGetNextSoundExFrequency(profiler,columnNameStr);
.Net	integer = profiler.GetNextSoundExFrequency(columnNameStr);