AAO DRAMA C++ Interface (Old style)
DRAMA C++, Depreciated, don't use for new code

◆ GetPath()

virtual DcppHandlerRet DcppTask::GetPath ( StatusType *const  status,
const DcppHandlerRoutine  SuccessHandler = 0,
const DcppHandlerRoutine  ErrorHandler = 0,
const DcppVoidPnt  ClientData = 0 
)
virtualinherited

Get a path to/load a the task.

This call initiates getting a path to the task. If the task is not running, it will be loaded if a sufficent information has been specified.

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 appropaite handler is invoked when the operation completes.

Parameters
statusInherited Status
SuccessHandlerDcppDispatch() 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.
ErrorHandlerDcppDispatch() 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.
ClientDataPassed directly to the handler functions.