[PATCH 7/8] doc: rtems_task_get_scheduler()

Sebastian Huber sebastian.huber at embedded-brains.de
Wed Apr 16 14:15:49 UTC 2014


---
 doc/user/smp.t |   34 ++++++++++++++++++++++++++++++++++
 1 files changed, 34 insertions(+), 0 deletions(-)

diff --git a/doc/user/smp.t b/doc/user/smp.t
index 4ed2735..9703c14 100644
--- a/doc/user/smp.t
+++ b/doc/user/smp.t
@@ -371,6 +371,40 @@ cleared bit means the opposite.
 None.
 
 @c
+ at c rtems_task_get_scheduler
+ at c
+ at page
+ at subsection TASK_GET_SCHEDULER - Get scheduler of a task
+
+ at subheading CALLING SEQUENCE:
+
+ at ifset is-C
+ at example
+rtems_status_code rtems_task_get_scheduler(
+  rtems_id  id,
+  rtems_id *scheduler_id
+);
+ at end example
+ at end ifset
+
+ at ifset is-Ada
+ at end ifset
+
+ at subheading DIRECTIVE STATUS CODES:
+
+ at code{@value{RPREFIX}SUCCESSFUL} - successful operation@*
+ at code{@value{RPREFIX}INVALID_ADDRESS} - @code{scheduler_id} is NULL@*
+ at code{@value{RPREFIX}INVALID_ID} - invalid task id
+
+ at subheading DESCRIPTION:
+
+Returns the scheduler identifier of a task in @code{scheduler_id}.
+
+ at subheading NOTES:
+
+None.
+
+ at c
 @c rtems_task_get_affinity
 @c
 @page
-- 
1.7.7




More information about the devel mailing list