PxPeStop_Hnd()

Stop periodic events (handler service).

APPLIES TO

1.0.0

SYNOPSIS
PxError_t PxPeStop_Hnd (PxPe_t PeId);
ARGUMENTS






PeId




Periodic event object

















RETURN VALUES






    

  • 

    PXROS error code
    

    • 







ERROR CODES















PXERR_PE_ILLPE




PeId is not a valid periodic event object handle








PXERR_REQUEST_ILLEGAL




The caller is not the requester of the PeId object









DESCRIPTION










PxPeStop stops signalling periodic events associated with Pe. This function should only be called from a handler.






















IMPLEMENTATION GUIDELINES
















Before call






    

  • 

    PeId must be a valid PXROS-HR periodic event object created with a PxPeRequest call (V). The validity of PeId may also be checked by the PxPeIsValid macro (F).
    

    • 



















After call






    

  • 

    The function returns PXERR_NOERROR if the periodic event could be stopped. Any other return value describes an error, which has to be interpreted (C).
    

    • 



















Best Practice






    

  • 

    This function should be called from handlers only. (V)
    

    • 






























SEE ALSO











USAGE








#include "pxdef.h"

PxError_t Err = PxPeStop_Hnd(PeId);

if (Err != PXERR_NOERROR) {
    // Report error
}