Difference between revisions of "Profiler Object:Column-Based Word Length Table Iteration"
Jump to navigation
Jump to search
| (One intermediate revision by the same user not shown) | |||
| Line 12: | Line 12: | ||
==StartWordLengthFrequency== | ==StartWordLengthFrequency== | ||
This function initiates the iterator. | 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. | This function takes two parameters. | ||
| Line 27: | Line 27: | ||
{{Object Syntax | {{Object Syntax | ||
|Syntax=profiler->StartWordLengthFrequency(columnNameStr, Order); | |Syntax=int = profiler->StartWordLengthFrequency(columnNameStr, Order); | ||
|C=mdProfilerStartWordLengthFrequency(profiler,columnNameStr, Order); | |C=int = mdProfilerStartWordLengthFrequency(profiler,columnNameStr, Order); | ||
|.Net=profiler.StartWordLengthFrequency(columnNameStr, Order); | |.Net=integer = profiler.StartWordLengthFrequency(columnNameStr, Order); | ||
}} | }} | ||
| Line 46: | Line 46: | ||
{{Object Syntax | {{Object Syntax | ||
|Syntax=profiler->GetWordLengthFrequencyValue(columnNameStr); | |Syntax=profiler->GetWordLengthFrequencyValue(columnNameStr); | ||
|C= | |C=const char* = mdProfilerGetWordLengthFrequencyValue(profiler,columnNameStr); | ||
|.Net=string = profiler.GetWordLengthFrequencyValue(columnNameStr); | |.Net=string = profiler.GetWordLengthFrequencyValue(columnNameStr); | ||
}} | }} | ||
Latest revision as of 16:34, 15 May 2015
These functions allow you to step through each distinct word length for a specific column.
StartWordLengthFrequency
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->StartWordLengthFrequency(columnNameStr, Order); |
|---|---|
| C | int = mdProfilerStartWordLengthFrequency(profiler,columnNameStr, Order); |
| .Net | integer = profiler.StartWordLengthFrequency(columnNameStr, Order); |
GetWordLengthFrequencyValue
This function returns a column's distinct word length.
This function takes one parameter.
Parameters
| Name | Data Type | Description |
|---|---|---|
| ColumnName | String | Column Name to get the column’s distinct word length. |
| Syntax | profiler->GetWordLengthFrequencyValue(columnNameStr); |
|---|---|
| C | const char* = mdProfilerGetWordLengthFrequencyValue(profiler,columnNameStr); |
| .Net | string = profiler.GetWordLengthFrequencyValue(columnNameStr); |
GetWordLengthFrequencyCount
This function returns the number of times the word 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 word length appears in the profiled data. |
| Syntax | profiler->GetWordLengthFrequencyCount(columnNameStr); |
|---|---|
| C | integer = mdProfilerGetWordLengthFrequencyCount(profiler,columnNameStr); |
| .Net | integer = profiler.GetWordLengthFrequencyCount(columnNameStr); |
GetNextWordLengthFrequency
This function steps to the next distinct word length. It returns 1 if there are more distinct word lengths or 0 when there are no more word lengths.
This function takes one parameter.
Parameters
| Name | Data Type | Description |
|---|---|---|
| ColumnName | String | Column Name to get the next distinct word length. |
| Syntax | profiler->GetNextWordLengthFrequency(columnNameStr); |
|---|---|
| C | integer = mdProfilerGetNextWordLengthFrequency(profiler,columnNameStr); |
| .Net | integer = profiler.GetNextWordLengthFrequency(columnNameStr); |