source: rtems/doc/user/dirstat.t @ 29e6637e

4.115
Last change on this file since 29e6637e was 2aeeaa0, checked in by Joel Sherrill <joel.sherrill@…>, on 03/10/14 at 14:47:06

doc: Improve description of rtems_status_text for ToC

  • Property mode set to 100644
File size: 2.4 KB
Line 
1@c
2@c  COPYRIGHT (c) 1989-2011.
3@c  On-Line Applications Research Corporation (OAR).
4@c  All rights reserved.
5
6@chapter Directive Status Codes
7
8@section Introduction
9
10@table @b
11@item @code{@value{RPREFIX}SUCCESSFUL} - successful completion
12@item @code{@value{RPREFIX}TASK_EXITTED} - returned from a task
13@item @code{@value{RPREFIX}MP_NOT_CONFIGURED} - multiprocessing not configured
14@item @code{@value{RPREFIX}INVALID_NAME} - invalid object name
15@item @code{@value{RPREFIX}INVALID_ID} - invalid object id
16@item @code{@value{RPREFIX}TOO_MANY} - too many
17@item @code{@value{RPREFIX}TIMEOUT} - timed out waiting
18@item @code{@value{RPREFIX}OBJECT_WAS_DELETED} - object was deleted while waiting
19@item @code{@value{RPREFIX}INVALID_SIZE} - invalid specified size
20@item @code{@value{RPREFIX}INVALID_ADDRESS} - invalid address specified
21@item @code{@value{RPREFIX}INVALID_NUMBER} - number was invalid
22@item @code{@value{RPREFIX}NOT_DEFINED} - item not initialized
23@item @code{@value{RPREFIX}RESOURCE_IN_USE} - resources outstanding
24@item @code{@value{RPREFIX}UNSATISFIED} - request not satisfied
25@item @code{@value{RPREFIX}INCORRECT_STATE} - task is in wrong state
26@item @code{@value{RPREFIX}ALREADY_SUSPENDED} - task already in state
27@item @code{@value{RPREFIX}ILLEGAL_ON_SELF} - illegal for calling task
28@item @code{@value{RPREFIX}ILLEGAL_ON_REMOTE_OBJECT} - illegal for remote object
29@item @code{@value{RPREFIX}CALLED_FROM_ISR} - invalid environment
30@item @code{@value{RPREFIX}INVALID_PRIORITY} - invalid task priority
31@item @code{@value{RPREFIX}INVALID_CLOCK} - invalid time buffer
32@item @code{@value{RPREFIX}INVALID_NODE} - invalid node id
33@item @code{@value{RPREFIX}NOT_CONFIGURED} - directive not configured
34@item @code{@value{RPREFIX}NOT_OWNER_OF_RESOURCE} - not owner of resource
35@item @code{@value{RPREFIX}NOT_IMPLEMENTED} - directive not implemented
36@item @code{@value{RPREFIX}INTERNAL_ERROR} - RTEMS inconsistency detected
37@item @code{@value{RPREFIX}NO_MEMORY} - could not get enough memory
38@end table
39
40@section Directives
41
42@page
43@subsection STATUS_TEXT - Returns the enumeration name for a status code
44
45@subheading CALLING SEQUENCE:
46
47@ifset is-C
48@findex rtems_status_text
49@example
50const char *rtems_status_text(
51  rtems_status_code code
52);
53@end example
54@end ifset
55
56@subheading DIRECTIVE STATUS CODES
57
58The status code enumeration name or "?" in case the status code is invalid.
59
60@subheading DESCRIPTION:
61
62Returns the enumeration name for the specified status code.
Note: See TracBrowser for help on using the repository browser.