PxTickSetTicksPerSecond()

Set the frequency of the internal PXROS tick.

APPLIES TO

1.0.0

SYNOPSIS
PxError_t PxTickSetTicksPerSecond (PxUInt_t tickspersecond);
ARGUMENTS






tickspersecond




number of calls to PxTickDefine_Hnd in one second

















RETURN VALUES






    

  • 

    PXROS error code
    

    • 







ERROR CODES















PXERR_ACCESS_RIGHT




the calling task has not the right to set the frequency









DESCRIPTION










PxTickSetTicksPerSecond sets the frequency of the internal PXROS tick. tickspersecond defines the number of calls to PxTickDefine_Hnd in one second.






















IMPLEMENTATION GUIDELINES
















Before call






    

  • 

    tickspersecond must be a plausible value given as a constant (V) or a variable (C).
    

    • 



















After call






    

  • 

    The function returns PXERR_NOERROR if the ticks per second could be set. Any other return value describes an error, which has to be interpreted. (C)
    

    • 



















Best Practice






    

  • 

    No restrictions.
    

    • 






























SEE ALSO











USAGE








#include "pxdef.h"

PxError_t Err = PxTickSetTicksPerSecond(2000);

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