14.3.20 remove (deletes specified data)
- Organization of this subsection
(1) Description
This subcommand deletes a specified key and the value associated with the key.
This subcommand is used to test whether the configured execution environment is operational.
(2) Rules
You can execute this subcommand when the EADS server is running.
(3) Format
eztool remove cache-name key
(4) Options and arguments
(a) cache-name
Specify the name of the cache containing the value you want to delete.
The following characters are permitted for a cache names:
-
If cache property files were not used to create caches
A maximum of 32 single-byte characters in ASCII codes 0x20 to 0x7E
-
If cache property files were used to create caches
A maximum of 32 single-byte alphanumeric characters (0 to 9, A to Z, and a to z)
(b) key
Specify the key associated with the value you want to delete.
For details about the data that can be specified as keys, see 15.2.2(1) Data types that can be specified as keys.
(5) Return code
The following table lists the return codes that this subcommand returns.
|
No. |
Return code |
Description |
|
|---|---|---|---|
|
eads.command.compat parameter omitted in the command properties |
0300 specified in the eads.command.compat parameter in the command properties |
||
|
1 |
0 |
0 |
Command execution was successful. |
|
2 |
101 |
101 |
Initialization of the command failed. |
|
3 |
120 |
The command failed due to a syntax error. |
|
|
4 |
150 |
The command failed during execution. |
|
|
5 |
200 |
The command failed due to a timeout. |
|
(6) Notes
You can use this subcommand to manipulate data processed by an API function; conversely, you can use an API function to manipulate data processed by this subcommand.
Note that the data types and sizes permitted for key and value are not completely compatible with those permitted by the API functions.