SelectAsync Method
Overloads
| SelectAsync(String, Boolean, Int32) |
Selects field values matching a search string. |
|
| SelectAsync(AsyncHandle, String, Boolean, Int32) |
Selects field values matching a search string. |
|
| SelectAsync<T>(AsyncHandle, Func<Response, T>, String, Boolean, Int32) |
Selects field values matching a search string. |
SelectAsync(String, Boolean, Int32)
Selects field values matching a search string.
Declaration
public Task<bool> SelectAsync([QixName("qMatch")] string match, [QixName("qSoftLock")] bool softLock = false, [QixName("qExcludedValuesMode")] int excludedValuesMode = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | match |
String to search for. Can contain wild cards or numeric search criteria. The characters <>"~()='[] have pre-defined meanings when used at the start of the string. To use them, EnableSpecialCharacterEscapingInSearch needs to be enabled and the delimiter \ needs to precede the special character. |
| System.Boolean | softLock |
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
| System.Int32 | excludedValuesMode |
Include excluded values in search. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Boolean> |
Implements
Remarks
The operation is successful if qReturn is set to true.
SelectAsync(AsyncHandle, String, Boolean, Int32)
Selects field values matching a search string.
Declaration
public Task<bool> SelectAsync(AsyncHandle asyncHandle, [QixName("qMatch")] string match, [QixName("qSoftLock")] bool softLock = false, [QixName("qExcludedValuesMode")] int excludedValuesMode = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.String | match |
String to search for. Can contain wild cards or numeric search criteria. The characters <>"~()='[] have pre-defined meanings when used at the start of the string. To use them, EnableSpecialCharacterEscapingInSearch needs to be enabled and the delimiter \ needs to precede the special character. |
| System.Boolean | softLock |
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
| System.Int32 | excludedValuesMode |
Include excluded values in search. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Boolean> |
Implements
Remarks
The operation is successful if qReturn is set to true.
SelectAsync<T>(AsyncHandle, Func<Response, T>, String, Boolean, Int32)
Selects field values matching a search string.
Declaration
public Task<T> SelectAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qMatch")] string match, [QixName("qSoftLock")] bool softLock = false, [QixName("qExcludedValuesMode")] int excludedValuesMode = 0)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.Func<Response, T> | onResult |
Continuation function |
| System.String | match |
String to search for. Can contain wild cards or numeric search criteria. The characters <>"~()='[] have pre-defined meanings when used at the start of the string. To use them, EnableSpecialCharacterEscapingInSearch needs to be enabled and the delimiter \ needs to precede the special character. |
| System.Boolean | softLock |
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. |
| System.Int32 | excludedValuesMode |
Include excluded values in search. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<T> |
Type Parameters
| Name | Description |
|---|---|
| T |
Implements
Remarks
The operation is successful if qReturn is set to true.
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!