Send a DRAMA message to the task to get the value of a parameter.
This is the basic method for sending an GET message to the task referred to by this object - to return the value of a single parameter. We must already have path to the task.
If this function returns DcppReschedule, then messages are expected and should be dispatched using DcppDispatch() when they arrive. This will ensure that future processing occurs correctly and the the appropriate handler is invoked when the operation completes.
- See also
- DcppTask::MGet
- Returns
- DcppReschedule if a message was started. Otherwise DcppFinished and status will be set bad.
- Parameters
-
name | The name of the parameter the value of which should be fetched. |
status | Inherited Status |
SuccessHandler | DcppDispatch() will invoke this if the operation completes successfully.
This function should return DcppReschedule if it sends another message.
Otherwise it should return DcppFinished.
The value returned will be returned by DcppDispatch(). If not specified, DcppDispatch() just returns DcppFinished. |
ErrorHandler | DcppDispatch() will invoke this if the operation fails after a message has been sent. This function should return DcppReschedule if it sends another message.
Otherwise it should return DcppFinished.
The value returned will be returned by DcppDispatch(). If not specified, DcppDispatch() just returns DcppFinished. |
ClientData | Passed directly to the handler functions. |
ErsHandler | DcppDispatch() will invoke this if a Ers message is received. If not specified, DcppDispatch just returns DcppReschedule, which is what your handler would normally return, since more messages are expected. This would normally only happen if the message was sent in UFACE context DitsInterested() was used to indicate an interest in ERS messages. |