Scripting::ArgsBlock Class Reference
#include <argsblock.h>
Detailed Description
Used to pass arguments into a script command and to pass the result of the command back.(C) 2006 Radon Labs GmbH
Public Member Functions | |
| ArgsBlock () | |
| constructor | |
| ~ArgsBlock () | |
| destructor | |
| bool | IsEmpty () const |
| return true if the argument block is empty | |
| void | Clear () |
| clear the argument block | |
| void | AddArg (const Util::String &name, Arg::Type type) |
| add an argument to the block | |
| SizeT | GetNumArgs () const |
| return number of arguments | |
| bool | HasArg (const Util::String &name) const |
| return true if argument exists by name | |
| const Util::String & | GetArgName (IndexT index) const |
| get argument name at index | |
| const Arg & | GetArgValue (IndexT index) const |
| get argument value at index (read-only) | |
| const Arg & | GetArgValue (const Util::String &name) const |
| get argument value by name (read-only) | |
| Arg & | ArgValue (IndexT index) |
| argument value at index (read/write) | |
| Arg & | ArgValue (const Util::String &name) |
| argument value by name (read/write) | |
Member Function Documentation
| void Scripting::ArgsBlock::AddArg | ( | const Util::String & | name, | |
| Arg::Type | type | |||
| ) |
add an argument to the block
Add argument to the args block. This method is usually called in the OnRegister() method of a script command object to setup the arguments and results block of the command.