MPDequeTasks

Syntax

#include <cafe/mp.h>

u32 MPDequeTasks(MPTaskQ* taskq, MPTaskPtr* tasks, int max_tasks);

Parameters

taskq The MPTaskQ that should be used.
tasks The tasks array to add tasks.
max_tasks The maximum amount of tasks to add to the tasks array.

Return Values

Number of valid tasks written to the tasks array. May return 0 if queue is empty.

Description

MPDequeTasks dequeues multiple tasks up to the given maximum from the specified MPTaskQ. May return 0 if the specified MPTaskQ is empty.

Do Not Call From

Multiple threads This function is not thread-safe.

See Also

MPDequeTask
MPEnqueTask
MPGetTaskQInfo
MPInitTaskQ
MPResetTaskQ
MPRunTasksFromTaskQ
MPStartTaskQ
MPStopTaskQ
MPTermTaskQ
MPWaitTaskQ
MPWaitTaskQWithTimeout

Revision History

2013-05-08 Automated cleanup pass.
2012-08-21 Cleanup Pass
2012-05-14 Fix See Also.
2012-05-04 Matched the actual prototype.
2010-08-23 Initial version.


CONFIDENTIAL