mpiSequenceCommandFirst
Declaration
int32_t mpiSequenceCommandFirst(MPISequence sequence)
Required Header: stdmpi.h
Description
mpiSequenceCommandFirst returns the first element in the list. This function can be used in conjuntion with mpiSequenceCommandNext(...) in order to iterate through the list.
NOTE: The maximum number of sequence commands that can exist on a controller, from all sequence objects, at one time is defined by MFWCmdBuffSizein MFW.h.
| sequence | a handle to the Sequence object. |
|---|
| Return Values | |
|---|---|
| handle | to the first Command in a Sequence (sequence) |
| MPIHandleVOID | if sequence is invalid if sequence is empty |
| MPIMessageHANDLE_INVALID | |