mpiCommandCreate
Declaration
MPI_RESULT mpiCommandCreate(MPICommand *command, MPICommandType type, MPICommandParams *params, const char *label);
Required Header: stdmpi.h
Change History: Modified in 04.00.
Description
mpiCommandCreate creates a Command object. The command type is specified by type. The type-specific parameters are specified by params. If label is not Null (i.e., something meaningful), then branch commands can call this Command (by using the label).
Note: CommandCreate is the equivalent of a C++ constructor.
| *command | A pointer to a command object handle |
|---|---|
| type | An enumerated command type, representing a single instruction for the controller to execute |
| *params | A pointer to a structure of command parameters |
| *label | A string to identify the command |
| Return Values |
|---|
| MPIMessageOK |
| MPIMessageNO_MEMORY |
| MPIMessagePARAM_INVALID |
| MPICommandMessageTYPE_INVALID |
See Also
mpiCommandDelete | mpiCommandValidate