GetFieldAndColumnSamplesAsync Method
Overloads
| GetFieldAndColumnSamplesAsync(IEnumerable<FieldOrColumn>, Int32, Int32) |
Get sample values from either a column in a table or from a field. Supports wildcard matches in tables or field names: - '*' for zero or more characters. - '?' for one character. |
|
| GetFieldAndColumnSamplesAsync(AsyncHandle, IEnumerable<FieldOrColumn>, Int32, Int32) |
Get sample values from either a column in a table or from a field. Supports wildcard matches in tables or field names: - '*' for zero or more characters. - '?' for one character. |
|
| GetFieldAndColumnSamplesAsync<T>(AsyncHandle, Func<Response, T>, IEnumerable<FieldOrColumn>, Int32, Int32) |
Get sample values from either a column in a table or from a field. Supports wildcard matches in tables or field names: - '*' for zero or more characters. - '?' for one character. |
GetFieldAndColumnSamplesAsync(IEnumerable<FieldOrColumn>, Int32, Int32)
Get sample values from either a column in a table or from a field.
Supports wildcard matches in tables or field names:
- '*' for zero or more characters.
- '?' for one character.
Declaration
Task<IEnumerable<SampleResult>> GetFieldAndColumnSamplesAsync([QixName("qFieldsOrColumnsWithWildcards")] IEnumerable<FieldOrColumn> fieldsOrColumnsWithWildcards, [QixName("qMaxNumberOfValues")] int maxNumberOfValues, [QixName("qRandSeed")] int randSeed = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<FieldOrColumn> | fieldsOrColumnsWithWildcards |
Pairs of table (optionally) and field names. Support wildcard matches. |
| System.Int32 | maxNumberOfValues |
Max number of sample values returned. Depending on the column or field size the number of returned samples can be less than MaxNumberOfValues. If MaxNumberOfValues is negative all sample values are returned. |
| System.Int32 | randSeed |
Optional. Sets the random number seed. Should only be set for test purposes. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<SampleResult>> |
GetFieldAndColumnSamplesAsync(AsyncHandle, IEnumerable<FieldOrColumn>, Int32, Int32)
Get sample values from either a column in a table or from a field.
Supports wildcard matches in tables or field names:
- '*' for zero or more characters.
- '?' for one character.
Declaration
Task<IEnumerable<SampleResult>> GetFieldAndColumnSamplesAsync(AsyncHandle asyncHandle, [QixName("qFieldsOrColumnsWithWildcards")] IEnumerable<FieldOrColumn> fieldsOrColumnsWithWildcards, [QixName("qMaxNumberOfValues")] int maxNumberOfValues, [QixName("qRandSeed")] int randSeed = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.Collections.Generic.IEnumerable<FieldOrColumn> | fieldsOrColumnsWithWildcards |
Pairs of table (optionally) and field names. Support wildcard matches. |
| System.Int32 | maxNumberOfValues |
Max number of sample values returned. Depending on the column or field size the number of returned samples can be less than MaxNumberOfValues. If MaxNumberOfValues is negative all sample values are returned. |
| System.Int32 | randSeed |
Optional. Sets the random number seed. Should only be set for test purposes. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<SampleResult>> |
GetFieldAndColumnSamplesAsync<T>(AsyncHandle, Func<Response, T>, IEnumerable<FieldOrColumn>, Int32, Int32)
Get sample values from either a column in a table or from a field.
Supports wildcard matches in tables or field names:
- '*' for zero or more characters.
- '?' for one character.
Declaration
Task<T> GetFieldAndColumnSamplesAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qFieldsOrColumnsWithWildcards")] IEnumerable<FieldOrColumn> fieldsOrColumnsWithWildcards, [QixName("qMaxNumberOfValues")] int maxNumberOfValues, [QixName("qRandSeed")] int randSeed = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.Func<Response, T> | onResult |
Continuation function |
| System.Collections.Generic.IEnumerable<FieldOrColumn> | fieldsOrColumnsWithWildcards |
Pairs of table (optionally) and field names. Support wildcard matches. |
| System.Int32 | maxNumberOfValues |
Max number of sample values returned. Depending on the column or field size the number of returned samples can be less than MaxNumberOfValues. If MaxNumberOfValues is negative all sample values are returned. |
| System.Int32 | randSeed |
Optional. Sets the random number seed. Should only be set for test purposes. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<T> |
Type Parameters
| Name | Description |
|---|---|
| T |
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!