DestroyVariableByIdAsync Method
Overloads
| DestroyVariableByIdAsync(String) |
Removes a variable. Script-defined variables cannot be removed using the |
|
| DestroyVariableByIdAsync(AsyncHandle, String) |
Removes a variable. Script-defined variables cannot be removed using the |
|
| DestroyVariableByIdAsync<T>(AsyncHandle, Func<Response, T>, String) |
Removes a variable. Script-defined variables cannot be removed using the |
DestroyVariableByIdAsync(String)
Removes a variable.
Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.
Declaration
Task<bool> DestroyVariableByIdAsync([QixName("qId")] string id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id |
Identifier of the variable. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Boolean> |
Remarks
The operation is successful if qSuccess is set to true.
DestroyVariableByIdAsync(AsyncHandle, String)
Removes a variable.
Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.
Declaration
Task<bool> DestroyVariableByIdAsync(AsyncHandle asyncHandle, [QixName("qId")] string id)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.String | id |
Identifier of the variable. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Boolean> |
Remarks
The operation is successful if qSuccess is set to true.
DestroyVariableByIdAsync<T>(AsyncHandle, Func<Response, T>, String)
Removes a variable.
Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method. For more information, see Remove a variable.
Declaration
Task<T> DestroyVariableByIdAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qId")] string id)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.Func<Response, T> | onResult |
Continuation function |
| System.String | id |
Identifier of the variable. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<T> |
Type Parameters
| Name | Description |
|---|---|
| T |
Remarks
The operation is successful if qSuccess is set to true.