os/ossrv/genericopenlibs/openenvcore/include/grp.dosc
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
/** @file ../include/grp.h
sl@0
     2
@internalComponent
sl@0
     3
*/
sl@0
     4
sl@0
     5
/** @fn  endgrent(void)
sl@0
     6
sl@0
     7
Refer to  getgrent() for the documentation
sl@0
     8
sl@0
     9
sl@0
    10
 
sl@0
    11
sl@0
    12
@publishedAll
sl@0
    13
@externallyDefinedApi
sl@0
    14
*/
sl@0
    15
sl@0
    16
/** @fn  *getgrent(void)
sl@0
    17
sl@0
    18
Note: This description also covers the following functions -
sl@0
    19
 getgrnam()  getgrnam_r()  getgrgid()  getgrgid_r()  setgroups()  setgrent()  endgrent() 
sl@0
    20
 
sl@0
    21
sl@0
    22
sl@0
    23
@code
sl@0
    24
sl@0
    25
@endcode
sl@0
    26
  These APIs are build supported but not available functionally. Symbian OS 
sl@0
    27
does not support multiple users and groups.
sl@0
    28
sl@0
    29
sl@0
    30
 
sl@0
    31
sl@0
    32
@publishedAll
sl@0
    33
@externallyDefinedApi
sl@0
    34
*/
sl@0
    35
sl@0
    36
/** @fn  *getgrgid(gid_t gid)
sl@0
    37
@param gid
sl@0
    38
Refer to  getgrent() for the documentation
sl@0
    39
sl@0
    40
@return The functions getgrent, getgrnam, and getgrgid, return a pointer to a group structure on success or NULL if the entry is not found or if an error occurs. If an error does occur, errno will be set. The functions getgrnam_r and getgrgid_r return 0 if no error occurred, or an error number to indicate failure. It is not an error if a matching entry is not found. (Thus, if result is set to NULL and the return value is 0, no matching entry exists.) 
sl@0
    41
The setgrent return the value 1 if successful, otherwise the value 0 is returned. The endgrent API has no return value. 
sl@0
    42
sl@0
    43
 
sl@0
    44
sl@0
    45
@publishedAll
sl@0
    46
@externallyDefinedApi
sl@0
    47
*/
sl@0
    48
sl@0
    49
/** @fn  *getgrnam(const char *)
sl@0
    50
sl@0
    51
Refer to  getgrent() for the documentation
sl@0
    52
sl@0
    53
sl@0
    54
 
sl@0
    55
sl@0
    56
@publishedAll
sl@0
    57
@externallyDefinedApi
sl@0
    58
*/
sl@0
    59
sl@0
    60
/** @fn  setgrent(void)
sl@0
    61
sl@0
    62
Refer to  getgrent() for the documentation
sl@0
    63
sl@0
    64
sl@0
    65
 
sl@0
    66
sl@0
    67
@publishedAll
sl@0
    68
@externallyDefinedApi
sl@0
    69
*/
sl@0
    70
sl@0
    71
/** @fn  getgrgid_r(gid_t gid, struct group *grp, char *, size_t, struct group **result)
sl@0
    72
@param gid
sl@0
    73
@param grp
sl@0
    74
@param result
sl@0
    75
Refer to  getgrent() for the documentation
sl@0
    76
sl@0
    77
sl@0
    78
 
sl@0
    79
sl@0
    80
@publishedAll
sl@0
    81
@externallyDefinedApi
sl@0
    82
*/
sl@0
    83
sl@0
    84
/** @fn  getgrnam_r(const char *name, struct group *grp, char *, size_t, struct group **result)
sl@0
    85
@param name
sl@0
    86
@param grp
sl@0
    87
@param result
sl@0
    88
sl@0
    89
Refer to  getgrent() for the documentation
sl@0
    90
sl@0
    91
sl@0
    92
 
sl@0
    93
sl@0
    94
@publishedAll
sl@0
    95
@externallyDefinedApi
sl@0
    96
*/
sl@0
    97
sl@0
    98
/** @struct group 
sl@0
    99
sl@0
   100
Includes the following members,
sl@0
   101
sl@0
   102
@publishedAll
sl@0
   103
@externallyDefinedApi
sl@0
   104
*/
sl@0
   105
sl@0
   106
/** @var group::gr_name
sl@0
   107
group name
sl@0
   108
*/
sl@0
   109
sl@0
   110
/** @var group::gr_passwd
sl@0
   111
group password
sl@0
   112
*/
sl@0
   113
sl@0
   114
/** @var group::gr_gid
sl@0
   115
group id
sl@0
   116
*/
sl@0
   117
sl@0
   118
/** @var group::gr_mem
sl@0
   119
group members
sl@0
   120
*/
sl@0
   121
sl@0
   122
/** @def _PATH_GROUP
sl@0
   123
@publishedAll
sl@0
   124
@released
sl@0
   125
*/