tfRegisterTimerCB

Jump to: navigation, search

Table of Contents >> Programmer's Reference


#include <trsocket.h>


int tfRegisterTimerCB (
ttUserTimerCBFuncPtr userTimerExpFunc,
ttUserGenericUnion userParm
);


Function Description

This function registers a callback function which indicates the amount of time that can pass before the user must call tfTimerExecute(). This should be done after just having called tfStartTreck().


Parameters

  • userTimerExpFunc
    This is the function that is invoked to update the user with the amount of time that can pass before the next required call to tfTimerExecute(). See ttUserTimerCBFunc for the function prototype for this callback.
  • userParm
    This is the user-defined data that is passed to the callback unmodified.


Returns

  • TM_ENOERROR
    Success
  • TM_EPERM
    The timer callback function could not be registered because the stack has not been initialized and started.


Table of Contents >> Programmer's Reference