source: rtems-docs/posix-users/language_specific_services.rst @ 72a62ad

4.115
Last change on this file since 72a62ad was 72a62ad, checked in by Chris Johns <chrisj@…>, on 11/03/16 at 05:58:08

Rename all manuals with an _ to have a -. It helps released naming of files.
  • Property mode set to 100644
File size: 9.4 KB
Line 
1.. comment SPDX-License-Identifier: CC-BY-SA-4.0
2
3.. COMMENT: COPYRIGHT (c) 1988-2002.
4.. COMMENT: On-Line Applications Research Corporation (OAR).
5.. COMMENT: All rights reserved.
6
7Language-Specific Services for the C Programming Language Manager
8#################################################################
9
10Introduction
11============
12
13The language-specific services for the C programming language manager is ...
14
15The directives provided by the language-specific services for the C programming language manager are:
16
17- setlocale_ - Set the Current Locale
18
19- fileno_ - Obtain File Descriptor Number for this File
20
21- fdopen_ - Associate Stream with File Descriptor
22
23- flockfile_ - Acquire Ownership of File Stream
24
25- ftrylockfile_ - Poll to Acquire Ownership of File Stream
26
27- funlockfile_ - Release Ownership of File Stream
28
29- getc_unlocked_ - Get Character without Locking
30
31- getchar_unlocked_ - Get Character from stdin without Locking
32
33- putc_unlocked_ - Put Character without Locking
34
35- putchar_unlocked_ - Put Character to stdin without Locking
36
37- setjmp_ - Save Context for Non-Local Goto
38
39- longjmp_ - Non-Local Jump to a Saved Context
40
41- sigsetjmp_ - Save Context with Signal Status for Non-Local Goto
42
43- siglongjmp_ - Non-Local Jump with Signal Status to a Saved Context
44
45- tzset_ - Initialize Time Conversion Information
46
47- strtok_r_ - Reentrant Extract Token from String
48
49- asctime_r_ - Reentrant struct tm to ASCII Time Conversion
50
51- ctime_r_ - Reentrant time_t to ASCII Time Conversion
52
53- gmtime_r_ - Reentrant UTC Time Conversion
54
55- localtime_r_ - Reentrant Local Time Conversion
56
57- rand_r_ - Reentrant Random Number Generation
58
59Background
60==========
61
62There is currently no text in this section.
63
64Operations
65==========
66
67There is currently no text in this section.
68
69Directives
70==========
71
72This section details the language-specific services for the C programming
73language manager's directives.  A subsection is dedicated to each of this
74manager's directives and describes the calling sequence, related constants,
75usage, and status codes.
76
77.. _setlocale:
78
79setlocale - Set the Current Locale
80----------------------------------
81.. index:: setlocale
82.. index:: set the current locale
83
84**CALLING SEQUENCE:**
85
86.. code-block:: c
87
88    int setlocale(
89    );
90
91**STATUS CODES:**
92
93.. list-table::
94 :class: rtems-table
95
96 * - ``E``
97   - The
98
99**DESCRIPTION:**
100
101**NOTES:**
102
103.. _fileno:
104
105fileno - Obtain File Descriptor Number for this File
106----------------------------------------------------
107.. index:: fileno
108.. index:: obtain file descriptor number for this file
109
110**CALLING SEQUENCE:**
111
112.. code-block:: c
113
114    int fileno(
115    );
116
117**STATUS CODES:**
118
119.. list-table::
120 :class: rtems-table
121
122 * - ``E``
123   - The
124
125**DESCRIPTION:**
126
127**NOTES:**
128
129.. _fdopen:
130
131fdopen - Associate Stream with File Descriptor
132----------------------------------------------
133.. index:: fdopen
134.. index:: associate stream with file descriptor
135
136**CALLING SEQUENCE:**
137
138.. code-block:: c
139
140    int fdopen(
141    );
142
143**STATUS CODES:**
144
145.. list-table::
146 :class: rtems-table
147
148 * - ``E``
149   - The
150
151**DESCRIPTION:**
152
153**NOTES:**
154
155.. _flockfile:
156
157flockfile - Acquire Ownership of File Stream
158--------------------------------------------
159.. index:: flockfile
160.. index:: acquire ownership of file stream
161
162**CALLING SEQUENCE:**
163
164.. code-block:: c
165
166    int flockfile(
167    );
168
169**STATUS CODES:**
170
171.. list-table::
172 :class: rtems-table
173
174 * - ``E``
175   - The
176
177**DESCRIPTION:**
178
179**NOTES:**
180
181.. _ftrylockfile:
182
183ftrylockfile - Poll to Acquire Ownership of File Stream
184-------------------------------------------------------
185.. index:: ftrylockfile
186.. index:: poll to acquire ownership of file stream
187
188**CALLING SEQUENCE:**
189
190.. code-block:: c
191
192    int ftrylockfile(
193    );
194
195**STATUS CODES:**
196
197.. list-table::
198 :class: rtems-table
199
200 * - ``E``
201   - The
202
203**DESCRIPTION:**
204
205**NOTES:**
206
207.. _funlockfile:
208
209funlockfile - Release Ownership of File Stream
210----------------------------------------------
211.. index:: funlockfile
212.. index:: release ownership of file stream
213
214**CALLING SEQUENCE:**
215
216.. code-block:: c
217
218    int funlockfile(
219    );
220
221**STATUS CODES:**
222
223.. list-table::
224 :class: rtems-table
225
226 * - ``E``
227   - The
228
229**DESCRIPTION:**
230
231**NOTES:**
232
233.. _getc_unlocked:
234
235getc_unlocked - Get Character without Locking
236---------------------------------------------
237.. index:: getc_unlocked
238.. index:: get character without locking
239
240**CALLING SEQUENCE:**
241
242.. code-block:: c
243
244    int getc_unlocked(
245    );
246
247**STATUS CODES:**
248
249.. list-table::
250 :class: rtems-table
251
252 * - ``E``
253   - The
254
255**DESCRIPTION:**
256
257**NOTES:**
258
259.. _getchar_unlocked:
260
261getchar_unlocked - Get Character from stdin without Locking
262-----------------------------------------------------------
263.. index:: getchar_unlocked
264.. index:: get character from stdin without locking
265
266**CALLING SEQUENCE:**
267
268.. code-block:: c
269
270    int getchar_unlocked(
271    );
272
273**STATUS CODES:**
274
275.. list-table::
276 :class: rtems-table
277
278 * - ``E``
279   - The
280
281**DESCRIPTION:**
282
283**NOTES:**
284
285.. _putc_unlocked:
286
287putc_unlocked - Put Character without Locking
288---------------------------------------------
289.. index:: putc_unlocked
290.. index:: put character without locking
291
292**CALLING SEQUENCE:**
293
294.. code-block:: c
295
296    int putc_unlocked(
297    );
298
299**STATUS CODES:**
300
301.. list-table::
302 :class: rtems-table
303
304 * - ``E``
305   - The
306
307**DESCRIPTION:**
308
309**NOTES:**
310
311.. _putchar_unlocked:
312
313putchar_unlocked - Put Character to stdin without Locking
314---------------------------------------------------------
315.. index:: putchar_unlocked
316.. index:: put character to stdin without locking
317
318**CALLING SEQUENCE:**
319
320.. code-block:: c
321
322    int putchar_unlocked(
323    );
324
325**STATUS CODES:**
326
327.. list-table::
328 :class: rtems-table
329
330 * - ``E``
331   - The
332
333**DESCRIPTION:**
334
335**NOTES:**
336
337.. _setjmp:
338
339setjmp - Save Context for Non-Local Goto
340----------------------------------------
341.. index:: setjmp
342.. index:: save context for non
343
344**CALLING SEQUENCE:**
345
346.. code-block:: c
347
348    int setjmp(
349    );
350
351**STATUS CODES:**
352
353.. list-table::
354 :class: rtems-table
355
356 * - ``E``
357   - The
358
359**DESCRIPTION:**
360
361**NOTES:**
362
363.. _longjmp:
364
365longjmp - Non-Local Jump to a Saved Context
366-------------------------------------------
367.. index:: longjmp
368.. index:: non
369
370**CALLING SEQUENCE:**
371
372.. code-block:: c
373
374    int longjmp(
375    );
376
377**STATUS CODES:**
378
379.. list-table::
380 :class: rtems-table
381
382 * - ``E``
383   - The
384
385**DESCRIPTION:**
386
387**NOTES:**
388
389.. _sigsetjmp:
390
391sigsetjmp - Save Context with Signal Status for Non-Local Goto
392--------------------------------------------------------------
393.. index:: sigsetjmp
394.. index:: save context with signal status for non
395
396**CALLING SEQUENCE:**
397
398.. code-block:: c
399
400    int sigsetjmp(
401    );
402
403**STATUS CODES:**
404
405.. list-table::
406 :class: rtems-table
407
408 * - ``E``
409   - The
410
411**DESCRIPTION:**
412
413**NOTES:**
414
415.. _siglongjmp:
416
417siglongjmp - Non-Local Jump with Signal Status to a Saved Context
418-----------------------------------------------------------------
419.. index:: siglongjmp
420.. index:: non
421
422**CALLING SEQUENCE:**
423
424.. code-block:: c
425
426    int siglongjmp(
427    );
428
429**STATUS CODES:**
430
431.. list-table::
432 :class: rtems-table
433
434 * - ``E``
435   - The
436
437**DESCRIPTION:**
438
439**NOTES:**
440
441.. _tzset:
442
443tzset - Initialize Time Conversion Information
444----------------------------------------------
445.. index:: tzset
446.. index:: initialize time conversion information
447
448**CALLING SEQUENCE:**
449
450.. code-block:: c
451
452    int tzset(
453    );
454
455**STATUS CODES:**
456
457.. list-table::
458 :class: rtems-table
459
460 * - ``E``
461   - The
462
463**DESCRIPTION:**
464
465**NOTES:**
466
467.. _strtok_r:
468
469strtok_r - Reentrant Extract Token from String
470----------------------------------------------
471.. index:: strtok_r
472.. index:: reentrant extract token from string
473
474**CALLING SEQUENCE:**
475
476.. code-block:: c
477
478    int strtok_r(
479    );
480
481**STATUS CODES:**
482
483.. list-table::
484 :class: rtems-table
485
486 * - ``E``
487   - The
488
489**DESCRIPTION:**
490
491**NOTES:**
492
493.. _asctime_r:
494
495asctime_r - Reentrant struct tm to ASCII Time Conversion
496--------------------------------------------------------
497.. index:: asctime_r
498.. index:: reentrant struct tm to ascii time conversion
499
500**CALLING SEQUENCE:**
501
502.. code-block:: c
503
504    int asctime_r(
505    );
506
507**STATUS CODES:**
508
509.. list-table::
510 :class: rtems-table
511
512 * - ``E``
513   - The
514
515**DESCRIPTION:**
516
517**NOTES:**
518
519.. _ctime_r:
520
521ctime_r - Reentrant time_t to ASCII Time Conversion
522---------------------------------------------------
523.. index:: ctime_r
524.. index:: reentrant time_t to ascii time conversion
525
526**CALLING SEQUENCE:**
527
528.. code-block:: c
529
530    int ctime_r(
531    );
532
533**STATUS CODES:**
534
535.. list-table::
536 :class: rtems-table
537
538 * - ``E``
539   - The
540
541**DESCRIPTION:**
542
543**NOTES:**
544
545.. _gmtime_r:
546
547gmtime_r - Reentrant UTC Time Conversion
548----------------------------------------
549.. index:: gmtime_r
550.. index:: reentrant utc time conversion
551
552**CALLING SEQUENCE:**
553
554.. code-block:: c
555
556    int gmtime_r(
557    );
558
559**STATUS CODES:**
560
561.. list-table::
562 :class: rtems-table
563
564 * - ``E``
565   - The
566
567**DESCRIPTION:**
568
569**NOTES:**
570
571.. _localtime_r:
572
573localtime_r - Reentrant Local Time Conversion
574---------------------------------------------
575.. index:: localtime_r
576.. index:: reentrant local time conversion
577
578**CALLING SEQUENCE:**
579
580.. code-block:: c
581
582    int localtime_r(
583    );
584
585**STATUS CODES:**
586
587.. list-table::
588 :class: rtems-table
589
590 * - ``E``
591   - The
592
593**DESCRIPTION:**
594
595**NOTES:**
596
597.. _rand_r:
598
599rand_r - Reentrant Random Number Generation
600-------------------------------------------
601.. index:: rand_r
602.. index:: reentrant random number generation
603
604**CALLING SEQUENCE:**
605
606.. code-block:: c
607
608    int rand_r(
609    );
610
611**STATUS CODES:**
612
613.. list-table::
614 :class: rtems-table
615
616 * - ``E``
617   - The
618
619**DESCRIPTION:**
620
621**NOTES:**
Note: See TracBrowser for help on using the repository browser.