os/ossrv/genericopenlibs/openenvcore/include/sys/utsname.dosc
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/ossrv/genericopenlibs/openenvcore/include/sys/utsname.dosc	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,96 @@
     1.4 +/** @file  ../include/sys/utsname.h
     1.5 +@internalComponent
     1.6 +*/
     1.7 +
     1.8 +/** @fn  uname(struct utsname *buf)
     1.9 +@param buf
    1.10 +@return   Upon successful completion, a non-negative value is returned. Otherwise, 
    1.11 +-1 is returned and errno is set to indicate the error.
    1.12 +
    1.13 +@code
    1.14 + sysname Name of the operating system implementation.
    1.15 + nodename Network name of this machine.
    1.16 + release Release level of the operating system.
    1.17 + version Version level of the operating system.
    1.18 + machine Machine hardware platform.
    1.19 +
    1.20 +@endcode
    1.21 +  The uname function stores NULL -terminated strings of information identifying the current system 
    1.22 +into the structure referenced by name .
    1.23 +
    1.24 + The utsname structure is defined in the \#include \<sys/utsname.h\> header file, and contains 
    1.25 +  the following members: sysname Name of the operating system implementation. nodename Network name of this machine. release Release level of the operating system. version Version level of the operating system. machine Machine hardware platform.
    1.26 +
    1.27 +Examples:
    1.28 +@code
    1.29 +#include <sys/utsname.h>
    1.30 +#include<stdio.h>
    1.31 +int test_uname()
    1.32 +{
    1.33 +    int retVal;
    1.34 +    struct utsname name ;
    1.35 +    retVal = uname( &name; );
    1.36 +    if( !retVal )       
    1.37 +    {
    1.38 +      printf("Sysname: %s
    1.39 + Nodename:%s
    1.40 + Release:
    1.41 +      %s
    1.42 +Version: %s
    1.43 +Machine:%s
    1.44 +");
    1.45 +      printf("uname passed");
    1.46 +      return 0;
    1.47 +    }
    1.48 +    else
    1.49 +    {
    1.50 +      printf("failed");
    1.51 +      return -1;
    1.52 +    }
    1.53 +}
    1.54 +
    1.55 +@endcode
    1.56 + Output
    1.57 +@code
    1.58 +Sysname: Symbian
    1.59 +Nodename: localhost
    1.60 +Release:
    1.61 +Version: 2:0:1055
    1.62 +Machine:
    1.63 +uname passed
    1.64 +
    1.65 +@endcode
    1.66 + 
    1.67 +
    1.68 +@publishedAll
    1.69 +@externallyDefinedApi
    1.70 +*/
    1.71 +
    1.72 +/** @struct utsname
    1.73 +
    1.74 +Contains the following members,
    1.75 +
    1.76 +@publishedAll
    1.77 +@externallyDefinedApi
    1.78 +*/
    1.79 +
    1.80 +/** @var utsname::sysname
    1.81 +Name of this OS.
    1.82 +*/
    1.83 +
    1.84 +/** @var utsname::nodename
    1.85 +Name of this network node.
    1.86 +*/
    1.87 +
    1.88 +/** @var utsname::release
    1.89 +Release level.
    1.90 +*/
    1.91 +
    1.92 +/** @var utsname::version
    1.93 +Version level.
    1.94 +*/
    1.95 +
    1.96 +/** @var utsname::machine
    1.97 +Hardware type.
    1.98 +*/
    1.99 +