PxTaskCheck()

Check the validity of a task.

APPLIES TO

1.0.0

SYNOPSIS
PxBool_t PxTaskCheck (PxTask_t TaskId);
ARGUMENTS






TaskId




The task object

















RETURN VALUES






    

  • 

    True if TaskId is a task object
    

    • 

  • 

    False if TaskId is not a task object
    

    • 







DESCRIPTION










PxTaskCheck checks the validity of a task object. The function returns true if the parameter is a valid task object, else false.






















IMPLEMENTATION GUIDELINES
















Before call






    

  • 

    TaskId must be a valid PXROS-HR task object created with a PxTaskCreate call (V). The validity of TaskId may also be checked by the PxTaskIsValid macro (F).
    

    • 



















After call






    

  • 

    No checks necessary.
    

    • 



















Best Practice






    

  • 

    No restrictions.
    

    • 






























SEE ALSO











USAGE








#include "pxdef.h"

if (!PxTaskCheck(TaskId)) {
    // Report not a task object
}