MPTermTask

Syntax

#include <cafe/mp.h>

BOOL MPTermTask(MPTask* task);

Parameters

task MPTask to dispose and cleanup.

Return Values

TRUE: the MPTask was finalized and terminated.
FALSE: the MPTask might be currently in use or running on another processor core.

Description

Finalizes use of the MPTask and disposes of any associated state. This function should be paired with MPInitTask function calls.

Do Not Call From

Multiple threads This function is not thread-safe.

See Also

MPGetTaskInfo
MPGetTaskUserData
MPInitTask
MPRunTask
MPSetTaskUserData

Revision History

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


CONFIDENTIAL