]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Source/include/task.h
xTaskGetTaskHandle() changed to xTaskGetHandle().
[freertos] / FreeRTOS / Source / include / task.h
index 385c66388d768d91293c6fb273d7fac2af7f1c96..c4bc0838da615e3ae8e812671759e1cb6cafce46 100644 (file)
@@ -840,7 +840,7 @@ eTaskState eTaskGetState( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;
 \r
 /**\r
  * task. h\r
- * <pre>void vTaskGetTaskInfo( TaskHandle_t xTask, TaskStatus_t *pxTaskStatus, BaseType_t xGetFreeStackSpace, eTaskState eState );</pre>\r
+ * <pre>void vTaskGetInfo( TaskHandle_t xTask, TaskStatus_t *pxTaskStatus, BaseType_t xGetFreeStackSpace, eTaskState eState );</pre>\r
  *\r
  * configUSE_TRACE_FACILITY must be defined as 1 for this function to be\r
  * available.  See the configuration section for more information.\r
@@ -877,22 +877,22 @@ eTaskState eTaskGetState( TaskHandle_t xTask ) PRIVILEGED_FUNCTION;
  TaskStatus_t xTaskDetails;\r
 \r
     // Obtain the handle of a task from its name.\r
-    xHandle = xTaskGetTaskHandle( "Task_Name" );\r
+    xHandle = xTaskGetHandle( "Task_Name" );\r
 \r
     // Check the handle is not NULL.\r
     configASSERT( xHandle );\r
 \r
     // Use the handle to obtain further information about the task.\r
-    vTaskGetTaskInfo( xHandle,\r
-                      &xTaskDetails,\r
-                      pdTRUE, // Include the high water mark in xTaskDetails.\r
-                      eInvalid ); // Include the task state in xTaskDetails.\r
+    vTaskGetInfo( xHandle,\r
+                  &xTaskDetails,\r
+                  pdTRUE, // Include the high water mark in xTaskDetails.\r
+                  eInvalid ); // Include the task state in xTaskDetails.\r
  }\r
    </pre>\r
- * \defgroup vTaskGetTaskInfo vTaskGetTaskInfo\r
+ * \defgroup vTaskGetInfo vTaskGetInfo\r
  * \ingroup TaskCtrl\r
  */\r
-void vTaskGetTaskInfo( TaskHandle_t xTask, TaskStatus_t *pxTaskStatus, BaseType_t xGetFreeStackSpace, eTaskState eState ) PRIVILEGED_FUNCTION;\r
+void vTaskGetInfo( TaskHandle_t xTask, TaskStatus_t *pxTaskStatus, BaseType_t xGetFreeStackSpace, eTaskState eState ) PRIVILEGED_FUNCTION;\r
 \r
 /**\r
  * task. h\r
@@ -1319,19 +1319,19 @@ char *pcTaskGetName( TaskHandle_t xTaskToQuery ) PRIVILEGED_FUNCTION; /*lint !e9
 \r
 /**\r
  * task. h\r
- * <PRE>TaskHandle_t xTaskGetTaskHandle( const char *pcNameToQuery );</PRE>\r
+ * <PRE>TaskHandle_t xTaskGetHandle( const char *pcNameToQuery );</PRE>\r
  *\r
  * NOTE:  This function takes a relatively long time to complete and should be\r
  * used sparingly.\r
  *\r
  * @return The handle of the task that has the human readable name pcNameToQuery.\r
- * NULL is returned if no matching name is found.  INCLUDE_xTaskGetTaskHandle\r
- * must be set to 1 in FreeRTOSConfig.h for pcTaskGetTaskHandle() to be available.\r
+ * NULL is returned if no matching name is found.  INCLUDE_xTaskGetHandle\r
+ * must be set to 1 in FreeRTOSConfig.h for pcTaskGetHandle() to be available.\r
  *\r
- * \defgroup pcTaskGetTaskHandle pcTaskGetTaskHandle\r
+ * \defgroup pcTaskGetHandle pcTaskGetHandle\r
  * \ingroup TaskUtils\r
  */\r
-TaskHandle_t xTaskGetTaskHandle( const char *pcNameToQuery ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
+TaskHandle_t xTaskGetHandle( const char *pcNameToQuery ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
 \r
 /**\r
  * task.h\r