Question on xTimerStart returned type

Kernel
#1

learningperson wrote on Thursday, October 12, 2017:

Hello, I’m completely new, (at the level of beginning at reading the manual) and I kindly request some information.

Question: In the “Mastering the FreeRTOS TM Real Time Kernel” copy 161204, Listing 74 documentation, should the discription of xTimerStart have a returned value of BaseType_t instead of TimerHandle_t?

TimerHandle_t xTimerStart( TimerHandle_t xTimer, TickType_t xTicksToWait ); // what is on Listing 74.
BaseType_t xTimerStart( TimerHandle_t xTimer, TickType_t xTicksToWait ); // what I think it should be.

BaseType_t would be consistant with the example code in listing 75:
BaseType_t xTimer1Started, xTimer2Started;

And BaseType_t would be consistant with table 28:
returned value of pdPASS or pdFALSE.

For example: pdPASS or pdFAIL is of type BaseType_t in the listing 13 documentation for xTaskCreate:

BaseType_t xTaskCreate( TaskFunction_t pvTaskCode,
const char * const pcName,
uint16_t usStackDepth,
void *pvParameters,
UBaseType_t uxPriority,
TaskHandle_t *pxCreatedTask );

Thank you in advance for your help.

#2

rtel wrote on Sunday, October 15, 2017:

Apologies for the delay in replying - you are right - it is an error in the book text as the return type is BaseType_t. You can see the actual function in FreeRTOS/source/include/timers.h.

#3

learningperson wrote on Tuesday, October 17, 2017:

Thank you for helping me. I think the book is very well written.