task_return
Previous Topic  Next Topic 

Synopsis:

        task_return(return_str)

Arguments:

     return_str = The string value to return to the parent task

Description:    This function stops the current task and sets the return value of the parent task to return_str.     If the task was started using the task_exec() function then this function will return with the value specified in the return_str .   If the parent task has been killed, or did not start the task using the task_exec() function, then the calling task will still be stopped but the return_str argument will be ignored.


Return Value:


This function stops the current task and does not return.