From fa70fd20878e402610c263f129266593d31a0376 Mon Sep 17 00:00:00 2001 From: Chris Johns Date: Fri, 26 Feb 2016 18:22:07 +1100 Subject: POSIX User clean up. --- posix_users/language_specific_services.rst | 295 +++++++++++++++++++---------- 1 file changed, 198 insertions(+), 97 deletions(-) (limited to 'posix_users/language_specific_services.rst') diff --git a/posix_users/language_specific_services.rst b/posix_users/language_specific_services.rst index 5c08933..b38c25c 100644 --- a/posix_users/language_specific_services.rst +++ b/posix_users/language_specific_services.rst @@ -1,55 +1,58 @@ +.. COMMENT: COPYRIGHT (c) 1988-2002. +.. COMMENT: On-Line Applications Research Corporation (OAR). +.. COMMENT: All rights reserved. + Language-Specific Services for the C Programming Language Manager ################################################################# Introduction ============ -The -language-specific services for the C programming language manager is ... +The language-specific services for the C programming language manager is ... The directives provided by the language-specific services for the C programming language manager are: -- ``setlocale`` - Set the Current Locale +- setlocale_ - Set the Current Locale -- ``fileno`` - Obtain File Descriptor Number for this File +- fileno_ - Obtain File Descriptor Number for this File -- ``fdopen`` - Associate Stream with File Descriptor +- fdopen_ - Associate Stream with File Descriptor -- ``flockfile`` - Acquire Ownership of File Stream +- flockfile_ - Acquire Ownership of File Stream -- ``ftrylockfile`` - Poll to Acquire Ownership of File Stream +- ftrylockfile_ - Poll to Acquire Ownership of File Stream -- ``funlockfile`` - Release Ownership of File Stream +- funlockfile_ - Release Ownership of File Stream -- ``getc_unlocked`` - Get Character without Locking +- getc_unlocked_ - Get Character without Locking -- ``getchar_unlocked`` - Get Character from stdin without Locking +- getchar_unlocked_ - Get Character from stdin without Locking -- ``putc_unlocked`` - Put Character without Locking +- putc_unlocked_ - Put Character without Locking -- ``putchar_unlocked`` - Put Character to stdin without Locking +- putchar_unlocked_ - Put Character to stdin without Locking -- ``setjmp`` - Save Context for Non-Local Goto +- setjmp_ - Save Context for Non-Local Goto -- ``longjmp`` - Non-Local Jump to a Saved Context +- longjmp_ - Non-Local Jump to a Saved Context -- ``sigsetjmp`` - Save Context with Signal Status for Non-Local Goto +- sigsetjmp_ - Save Context with Signal Status for Non-Local Goto -- ``siglongjmp`` - Non-Local Jump with Signal Status to a Saved Context +- siglongjmp_ - Non-Local Jump with Signal Status to a Saved Context -- ``tzset`` - Initialize Time Conversion Information +- tzset_ - Initialize Time Conversion Information -- ``strtok_r`` - Reentrant Extract Token from String +- strtok_r_ - Reentrant Extract Token from String -- ``asctime_r`` - Reentrant struct tm to ASCII Time Conversion +- asctime_r_ - Reentrant struct tm to ASCII Time Conversion -- ``ctime_r`` - Reentrant time_t to ASCII Time Conversion +- ctime_r_ - Reentrant time_t to ASCII Time Conversion -- ``gmtime_r`` - Reentrant UTC Time Conversion +- gmtime_r_ - Reentrant UTC Time Conversion -- ``localtime_r`` - Reentrant Local Time Conversion +- localtime_r_ - Reentrant Local Time Conversion -- ``rand_r`` - Reentrant Random Number Generation +- rand_r_ - Reentrant Random Number Generation Background ========== @@ -64,10 +67,12 @@ There is currently no text in this section. Directives ========== -This section details the language-specific services for the C programming language manager's directives. -A subsection is dedicated to each of this manager's directives -and describes the calling sequence, related constants, usage, -and status codes. +This section details the language-specific services for the C programming +language manager's directives. A subsection is dedicated to each of this +manager's directives and describes the calling sequence, related constants, +usage, and status codes. + +.. _setlocale: setlocale - Set the Current Locale ---------------------------------- @@ -76,20 +81,25 @@ setlocale - Set the Current Locale **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int setlocale( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _fileno: + fileno - Obtain File Descriptor Number for this File ---------------------------------------------------- .. index:: fileno @@ -97,20 +107,25 @@ fileno - Obtain File Descriptor Number for this File **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int fileno( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _fdopen: + fdopen - Associate Stream with File Descriptor ---------------------------------------------- .. index:: fdopen @@ -118,20 +133,25 @@ fdopen - Associate Stream with File Descriptor **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int fdopen( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _flockfile: + flockfile - Acquire Ownership of File Stream -------------------------------------------- .. index:: flockfile @@ -139,20 +159,25 @@ flockfile - Acquire Ownership of File Stream **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int flockfile( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _ftrylockfile: + ftrylockfile - Poll to Acquire Ownership of File Stream ------------------------------------------------------- .. index:: ftrylockfile @@ -160,20 +185,25 @@ ftrylockfile - Poll to Acquire Ownership of File Stream **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int ftrylockfile( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _funlockfile: + funlockfile - Release Ownership of File Stream ---------------------------------------------- .. index:: funlockfile @@ -181,20 +211,25 @@ funlockfile - Release Ownership of File Stream **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int funlockfile( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _getc_unlocked: + getc_unlocked - Get Character without Locking --------------------------------------------- .. index:: getc_unlocked @@ -202,20 +237,25 @@ getc_unlocked - Get Character without Locking **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int getc_unlocked( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _getchar_unlocked: + getchar_unlocked - Get Character from stdin without Locking ----------------------------------------------------------- .. index:: getchar_unlocked @@ -223,20 +263,25 @@ getchar_unlocked - Get Character from stdin without Locking **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int getchar_unlocked( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _putc_unlocked: + putc_unlocked - Put Character without Locking --------------------------------------------- .. index:: putc_unlocked @@ -244,20 +289,25 @@ putc_unlocked - Put Character without Locking **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int putc_unlocked( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _putchar_unlocked: + putchar_unlocked - Put Character to stdin without Locking --------------------------------------------------------- .. index:: putchar_unlocked @@ -265,20 +315,25 @@ putchar_unlocked - Put Character to stdin without Locking **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int putchar_unlocked( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _setjmp: + setjmp - Save Context for Non-Local Goto ---------------------------------------- .. index:: setjmp @@ -286,20 +341,25 @@ setjmp - Save Context for Non-Local Goto **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int setjmp( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _longjmp: + longjmp - Non-Local Jump to a Saved Context ------------------------------------------- .. index:: longjmp @@ -307,20 +367,25 @@ longjmp - Non-Local Jump to a Saved Context **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int longjmp( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _sigsetjmp: + sigsetjmp - Save Context with Signal Status for Non-Local Goto -------------------------------------------------------------- .. index:: sigsetjmp @@ -328,20 +393,25 @@ sigsetjmp - Save Context with Signal Status for Non-Local Goto **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int sigsetjmp( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _siglongjmp: + siglongjmp - Non-Local Jump with Signal Status to a Saved Context ----------------------------------------------------------------- .. index:: siglongjmp @@ -349,20 +419,25 @@ siglongjmp - Non-Local Jump with Signal Status to a Saved Context **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int siglongjmp( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _tzset: + tzset - Initialize Time Conversion Information ---------------------------------------------- .. index:: tzset @@ -370,20 +445,25 @@ tzset - Initialize Time Conversion Information **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int tzset( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _strtok_r: + strtok_r - Reentrant Extract Token from String ---------------------------------------------- .. index:: strtok_r @@ -391,20 +471,25 @@ strtok_r - Reentrant Extract Token from String **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int strtok_r( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _asctime_r: + asctime_r - Reentrant struct tm to ASCII Time Conversion -------------------------------------------------------- .. index:: asctime_r @@ -412,20 +497,25 @@ asctime_r - Reentrant struct tm to ASCII Time Conversion **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int asctime_r( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _ctime_r: + ctime_r - Reentrant time_t to ASCII Time Conversion --------------------------------------------------- .. index:: ctime_r @@ -433,20 +523,25 @@ ctime_r - Reentrant time_t to ASCII Time Conversion **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int ctime_r( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _gmtime_r: + gmtime_r - Reentrant UTC Time Conversion ---------------------------------------- .. index:: gmtime_r @@ -454,20 +549,25 @@ gmtime_r - Reentrant UTC Time Conversion **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int gmtime_r( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _localtime_r: + localtime_r - Reentrant Local Time Conversion --------------------------------------------- .. index:: localtime_r @@ -475,20 +575,25 @@ localtime_r - Reentrant Local Time Conversion **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int localtime_r( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** +.. _rand_r: + rand_r - Reentrant Random Number Generation ------------------------------------------- .. index:: rand_r @@ -496,23 +601,19 @@ rand_r - Reentrant Random Number Generation **CALLING SEQUENCE:** -.. code:: c +.. code-block:: c int rand_r( ); **STATUS CODES:** -*E* - The +.. list-table:: + :class: rtems-table + + * - ``E`` + - The **DESCRIPTION:** **NOTES:** - -.. COMMENT: COPYRIGHT (c) 1988-2002. - -.. COMMENT: On-Line Applications Research Corporation (OAR). - -.. COMMENT: All rights reserved. - -- cgit v1.2.3