diff --git a/Documentation/NuttxUserGuide.html b/Documentation/NuttxUserGuide.html index 6aa9905fe06..70d8a6c7fa2 100644 --- a/Documentation/NuttxUserGuide.html +++ b/Documentation/NuttxUserGuide.html @@ -13,7 +13,7 @@

NuttX Operating System

User's Manual

by

Gregory Nutt

-

Last Updated: June 2, 2015

+

Last Updated: June 12, 2015

@@ -3884,14 +3884,18 @@ interface of the same name.
  • 2.6.4 mktime
  • 2.6.5 gmtime
  • 2.6.6 localtime
    • -
  • 2.6.7 gmtime_r
    • -
  • 2.6.8 localtime_r
    • -
  • 2.6.9 timer_create
    • -
  • 2.6.10 timer_delete
    • -
  • 2.6.11 timer_settime
    • -
  • 2.6.12 timer_gettime
    • -
  • 2.6.13 timer_getoverrun
    • -
  • 2.6.14 gettimeofday
    • +
  • 2.6.7 asctime
    • +
  • 2.6.8 ctime
    • +
  • 2.6.9 gmtime_r
    • +
  • 2.6.10 localtime_r
    • +
  • 2.6.11 asctime_r
    • +
  • 2.6.12 ctime_r
    • +
  • 2.6.13 timer_create
    • +
  • 2.6.14 timer_delete
    • +
  • 2.6.15 timer_settime
    • +
  • 2.6.16 timer_gettime
    • +
  • 2.6.17 timer_getoverrun
    • +
  • 2.6.18 gettimeofday

    • 2.6.1 clock_settime

    @@ -3913,14 +3917,9 @@ interface of the same name.

    Returned Value: -

    -

    If successful, the clock_settime() function will return zero (OK). Otherwise, an non-zero error number will be returned to indicate the error:

    -

    2.6.2 clock_gettime

    @@ -3941,14 +3940,9 @@ interface of the same name.

    Returned Value: -

    -

    If successful, the clock_gettime() function will return zero (OK). Otherwise, an non-zero error number will be returned to indicate the error:

    -

    2.6.3 clock_getres

    @@ -3969,14 +3963,9 @@ interface of the same name.

    Returned Value: -

    -

    If successful, the clock_getres() function will return zero (OK). Otherwise, an non-zero error number will be returned to indicate the error:

    -

    2.6.4 mktime

    @@ -3997,14 +3986,9 @@ interface of the same name.

    Returned Value: -

    -

    If successful, the mktime() function will return zero (OK). Otherwise, an non-zero error number will be returned to indicate the error:

    -

    2.6.5 gmtime

    @@ -4012,80 +3996,241 @@ interface of the same name. 

         #include <time.h>
-    struct tm *gmtime(const time_t *clock);
+    FAR struct tm *gmtime(FAR const time_t *timep);

    Description: + Represents GMT date/time in a type struct tm. + This function is not re-entrant.

    Input Parameters:

    Returned Value: -

    -

    - If successful, the gmtime() function will return the pointer to a statically - defined instance of struct tim. + If successful, the gmtime() function will return the pointer to a statically defined instance of struct tm. Otherwise, a NULL will be returned to indicate the error:

    -

    2.6.6 localtime

    -
    -    #include <time.h>
-    #define localtime(c) gmtime(c)
-
    + +

    + Description: + Represents local date/time in a type struct tm. + This function is not re-entrant. +

    +

    + Input Parameters: +

    + +

    + Returned Value: + Returned Value: + If successful, the localtime() function will return the pointer to a statically defined instance of struct tm. + Otherwise, a NULL will be returned to indicate the error: +

    -

    2.6.7 gmtime_r

    +

    2.6.7 asctime

    +

    + Function Prototype: +

    + +

    + Description: + asctime() convert the time provided in a struct tm to a string representation. + asctime() is not re-entrant. +

    +

    + Input Parameters: +

    + +

    + Returned Value: + If successful, the asctime() function will return a pointer to a statically defined string holding the converted time. + Otherwise, a NULL will be returned to indicate the error. +

    + +

    2.6.8 ctime

    +

    + Function Prototype: +

    + +

    + Description: + ctime() converts the time provided in seconds since the epoch to a string representation. + ctime() is not re-entrant. +

    +

    + Input Parameters: +

    + +

    + Returned Value: + If successful, the ctime() function will return the pointer to the converted string. + Otherwise, a NULL will be returned to indicate the error. +

    + +

    2.6.9 gmtime_r

    Function Prototype: 

         #include <time.h>
-    struct tm *gmtime_r(const time_t *clock, struct tm *result);
+    struct tm *gmtime_r(const time_t *timep, struct tm *result);

    Description: + Represents GMT date/time in a type struct tm. + This function is re-entrant.

    Input Parameters:

    Returned Value: -

    -

    If successful, the gmtime_r() function will return the pointer, result, provided by the caller. Otherwise, a NULL will be returned to indicate the error:

    + +

    2.6.10 localtime_r

    + +

    + Description: + Represents local date/time in a type struct tm. + This function is re-entrant. +

    +

    + Input Parameters: +

    +

    + Returned Value: + Returned Value: + If successful, the localtime_r() function will return the pointer, result, + provided by the caller. + Otherwise, a NULL will be returned to indicate the error: +

    -

    2.6.8 localtime_r

    -
    -    #include <time.h>
-    #define localtime_r(c,r) gmtime_r(c,r)
-
    +

    2.6.11 asctime_r

    +

    + Function Prototype: +

    + +

    + Description: + asctime_r() converts the time provided in a struct tm to a string representation. + asctime-r() is re-entrant. +

    +

    + Input Parameters: +

    + +

    + Returned Value: + If successful, the asctime_r() function will return the pointer, buf, provided by the caller. + Otherwise, a NULL will be returned to indicate the error. +

    -

    2.6.9 timer_create

    +

    2.6.12 ctime_r

    +

    + Function Prototype: +

    + +

    + Description: + ctime_r() converts the time provided in seconds since the epoch to a string representation. + ctime() is re-entrant. +

    +

    + Input Parameters: +

    + +

    + Returned Value: + If successful, the ctime_r() function will return the pointer, buf, provided by the caller. + Otherwise, a NULL will be returned to indicate the error. +

    + +

    2.6.13 timer_create

    Function Prototype:

    @@ -4130,8 +4275,6 @@ interface of the same name.

    Returned Value: -

    -

    If the call succeeds, timer_create() will return 0 (OK) and update the location referenced by timerid to a timer_t, which can be passed to the other per-thread timer calls. If an error occurs, the function will return @@ -4155,7 +4298,7 @@ interface of the same name.

  • Only CLOCK_REALTIME is supported for the clockid argument.
    • -

    2.6.10 timer_delete

    +

    2.6.14 timer_delete

    Function Prototype:

    @@ -4180,8 +4323,6 @@ interface of the same name.

    Returned Value: -

    -

    If successful, the timer_delete() function will return zero (OK). Otherwise, the function will return a value of -1 (ERROR) and set errno to indicate the error: @@ -4194,7 +4335,7 @@ interface of the same name. Comparable to the POSIX interface of the same name.

    -

    2.6.11 timer_settime

    +

    2.6.15 timer_settime

    Function Prototype:

    @@ -4258,8 +4399,6 @@ interface of the same name.

    Returned Value: -

    -

    If the timer_gettime() succeeds, a value of 0 (OK) will be returned. If an error occurs, the value -1 (ERROR) will be returned, and errno set to indicate the error. @@ -4277,7 +4416,7 @@ interface of the same name.

  • The ovalue argument is ignored.
    • -

    2.6.12 timer_gettime

    +

    2.6.16 timer_gettime

    Function Prototype:

    @@ -4309,8 +4448,6 @@ interface of the same name.

    Returned Value: -

    -

    If successful, the timer_gettime() function will return zero (OK). Otherwise, an non-zero error number will be returned to indicate the error:

    @@ -4324,7 +4461,7 @@ interface of the same name. Comparable to the POSIX interface of the same name.

    -

    2.6.13 timer_getoverrun

    +

    2.6.17 timer_getoverrun

    Function Prototype:

    @@ -4385,7 +4522,7 @@ interface of the same name. interface of the same name.

    -

    2.6.14 gettimeofday

    +

    2.6.18 gettimeofday

    Function Prototype:

    @@ -9754,6 +9891,8 @@ notify a task when a message is available on a queue.
  • aio_return
  • aio_suspend
  • aio_write
    • +
  • asctime
    • +
  • asctime_r
  • atexit
  • bind
  • BIOC_XIPBASE
    • @@ -9766,6 +9905,8 @@ notify a task when a message is available on a queue.
  • closedir
  • connect
  • creat
    • +
  • ctime
    • +
  • ctime_r
  • Data structures
  • Directory operations
  • dirent.h
    • @@ -9829,10 +9970,10 @@ notify a task when a message is available on a queue.
  • mq_timedsend
  • mq_unlink
  • mmap
    • -
  • Network Interfaces
    • -
  • on_exit +
  • Network Interfaces
    • +
  • on_exit
  • open
  • opendir
  • OS Interfaces