PxTaskGetAccessRights()

Return the access rights of a task.

APPLIES TO

8.2.0

SYNOPSIS
PxUInt_t PxTaskGetAccessRights (PxTask_t TaskId);
ARGUMENTS






TaskId




Task whose access rights are requested

















RETURN VALUES






    

  • 

    Access rights of given task
    

    • 







ERROR CODES















PXERR_GLOBAL_ILLEGAL_CORE




The requested task is not on the same core








PXERR_TASK_ILLTASK




TaskId is not a valid task object









DESCRIPTION










PxTaskGetAccessRights returns the access rights of the task TaskId.






















IMPLEMENTATION GUIDELINES
















Before call






    

  • 

    The parameter TaskId must be a valid task object id. This id may be
    

    

      

    • 

      the calling task’s own id read by calling PxGetId() (V)
      

      • 

    • 

      the return value of a PxTaskCreate() call (V)
      

      • 

    • 

      the result of a nameserver query (V)
      

      • 

    • 

      part of a message sent by another task (V)
      

      • 

    

    

    • 

  • 

    Additionally the task id may be checked with PxTaskCheck() (F).The task object must be created on the same core as the caller runs on. The creator core id can be read with the macro PxTaskCoreId and the own core id with PxGetCoreId (C).
    

    • 



















After call






    

  • 

    PxTaskGetAccessRights returns a null value on failure (C). In this case the task must call PxGetError to check which error has occurred (F).
    

    • 



















Best Practice






    

  • 

    No restrictions.
    

    • 






























SEE ALSO











USAGE








#include "pxdef.h"

PxUInt_t Rights = PxTaskGetAccessRights(TaskId);