MPTermTaskQ

Syntax

#include <cafe/mp.h>

BOOL MPTermTaskQ(MPTaskQ *taskq);

Parameters

taskq MPTaskQ to clean up.

Return Values

TRUE: the specified MPTaskQ was finalized and cleaned up.
FALSE: the specified MPTaskQ could not be cleaned up. In this case, the MPTaskQ might still be running.

Description

MPTermTaskQ is called to finalize the cleanup of the MPTaskQ. The MPTaskQ must be stopped in order for this function to succeed.

NOTE:
MPTermTaskQ is a placeholder for any later enhancement needs. Currently, it always returns TRUE.

Do Not Call From

Multiple threads This function is not thread-safe.

See Also

MPDequeTask
MPDequeTasks
MPEnqueTask
MPGetTaskQInfo
MPInitTaskQ
MPResetTaskQ
MPRunTasksFromTaskQ
MPStartTaskQ
MPStopTaskQ
MPWaitTaskQ
MPWaitTaskQWithTimeout

Revision History

2013-05-08 Automated cleanup pass.
2012-05-14 Fixed See Also.
2010-08-23 Initial version.


CONFIDENTIAL