Profiler Object:Column-Based Word Table Iteration: Difference between revisions
Jump to navigation
Jump to search
Created page with " ← Profiler Object Reference {| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa; font-size..." |
No edit summary |
||
| Line 27: | Line 27: | ||
{| class="mw-collapsible mw-collapsed" style="width:100%;" | {| class="mw-collapsible mw-collapsed" style="width:100%;" | ||
|- align="left" | |- align="left" | ||
! style="color:black;"|[[Profiler Object:Column-Based Statistics|Column-Based Statistics]] | ! style="color:black; text-align:left;"|[[Profiler Object:Column-Based Statistics|Column-Based Statistics]] | ||
|- | |- | ||
|[[Profiler Object:Column-Based String Statistics|Column-Based String Statistics]] | |[[Profiler Object:Column-Based String Statistics|Column-Based String Statistics]] | ||
| Line 52: | Line 52: | ||
{| class="mw-collapsible" style="width:100%;" | {| class="mw-collapsible" style="width:100%;" | ||
|- align="left" | |- align="left" | ||
! style="color:black;"|[[Profiler Object:Iterators|Iterators]] | ! style="color:black; text-align:left;"|[[Profiler Object:Iterators|Iterators]] | ||
|- | |- | ||
|[[Profiler Object:Column-Based Value Frequency Table Iteration|Column-Based Value Frequency Table Iteration]] | |[[Profiler Object:Column-Based Value Frequency Table Iteration|Column-Based Value Frequency Table Iteration]] | ||
| Line 73: | Line 73: | ||
{| class="mw-collapsible mw-collapsed" style="width:100%;" | {| class="mw-collapsible mw-collapsed" style="width:100%;" | ||
|- align="left" | |- align="left" | ||
! style="color:black;"|[[Profiler Object:Result Codes|Result Codes]] | ! style="color:black; text-align:left;"|[[Profiler Object:Result Codes|Result Codes]] | ||
|- | |- | ||
|[[Returned Result Codes:APIs#Profiler Object|Returned Result Codes]] | |[[Returned Result Codes:APIs#Profiler Object|Returned Result Codes]] | ||
Revision as of 18:54, 2 February 2015
These functions allow you to step through each distinct word for a specific column.
StartWordFrequency
This function initiates the iterator.
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 | profiler->StartWordFrequency(columnNameStr, Order); |
|---|---|
| C | mdProfilerStartWordFrequency(profiler,columnNameStr, Order); |
| .Net | profiler.StartWordFrequency(columnNameStr, Order); |
GetWordFrequencyValue
This function returns a column's distinct word.
This function takes one parameter.
Parameters
| Name | Data Type | Description |
|---|---|---|
| ColumnName | String | Column Name to get the column’s distinct word. |
| Syntax | profiler->GetWordFrequencyValue(columnNameStr); |
|---|---|
| C | string = mdProfilerGetWordFrequencyValue(profiler,columnNameStr); |
| .Net | string = profiler.GetWordFrequencyValue(columnNameStr); |
GetWordFrequencyCount
This function returns the number of times the word appears in the profiled data for this particular column. Multiple occurrences of the same word in a single record will all be counted.
This function takes one parameter.
Parameters
| Name | Data Type | Description |
|---|---|---|
| ColumnName | String | Column Name to get the number of times the word appears in the profiled data. |
| Syntax | profiler->GetWordFrequencyCount(columnNameStr); |
|---|---|
| C | integer = mdProfilerGetWordFrequencyCount(profiler,columnNameStr); |
| .Net | integer = profiler.GetWordFrequencyCount(columnNameStr); |
GetNextWordFrequency
This function steps to the next distinct word. 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 word. |
| Syntax | profiler->GetNextWordFrequency(columnNameStr); |
|---|---|
| C | integer = mdProfilerGetNextWordFrequency(profiler,columnNameStr); |
| .Net | integer = profiler.GetNextWordFrequency(columnNameStr); |