Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 4
Next »
Group | Generic |
|---|
| Description | Run an RT-LAB command for a certain RT-Lab object.
See the OP_COMMAND enumeration for a complete list of available commands and their specific requirements. |
|---|
| Required Control | Specific to each command, see OP_COMMAND |
|---|
| Usage | outputId = RtlabApi.Command (ownerId, command, attributes, values) |
|---|
| Input | - ownerId: The ID of the object that owns the command. Where there is ambiguity, the owner of the two objects is the expected ID. For example, CMD_REMOVE: when the owner is a project, the command removes a model.
- command: The command to be executed (see OP_COMMAND).
- attributes: The tuple of attributes to send as command arguments (see OP_ATTRIBUTE). The size of the tuple must match the size of the attributeValues tuple.
- values: The tuple of attribute values to send as command arguments. The size of the tuple must match the size of the attributes tuple.
|
|---|
| Output | - outputId: The ID corresponding to the object directly affected by the command. If no other object than the parent is affected, the parent ID is returned.
|
|---|
| Return Value | - EOK: Success.
- EBADF: Unsupported ownerId.
- EINVAL: Invalid arguments specified.
- EIO: Error sending the request or receiving the reply.
- ENOMEM: Error allocation memory for request or reply.
|
|---|
| Examples | None |
|---|
| Related Items | OP_COMMAND, OP_ATTRIBUTE |
|---|
| Modules | import RtlabApi |
|---|
