DestroyVariableByNameAsync Method
Overloads
| DestroyVariableByNameAsync(String) |
Removes a variable. Script-defined variables cannot be removed using the |
|
| DestroyVariableByNameAsync(AsyncHandle, String) |
Removes a variable. Script-defined variables cannot be removed using the |
|
| DestroyVariableByNameAsync<T>(AsyncHandle, Func<Response, T>, String) |
Removes a variable. Script-defined variables cannot be removed using the |
DestroyVariableByNameAsync(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> DestroyVariableByNameAsync([QixName("qName")] string name)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name |
Name of the variable. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Boolean> |
Remarks
The operation is successful if qSuccess is set to true.
DestroyVariableByNameAsync(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> DestroyVariableByNameAsync(AsyncHandle asyncHandle, [QixName("qName")] string name)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.String | name |
Name of the variable. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Boolean> |
Remarks
The operation is successful if qSuccess is set to true.
DestroyVariableByNameAsync<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> DestroyVariableByNameAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qName")] string name)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.Func<Response, T> | onResult |
Continuation function |
| System.String | name |
Name 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.
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!