system/freebsd-src
system/freebsd-src
1
0
Fork 0
mirror of https://github.com/freebsd/freebsd-src synced 2024-10-01 14:14:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

login_cap(3): Document login_getcapenum()

Browse source 
Reviewed by:            emaste
Approved by:            emaste (mentor)
MFC after:              3 days
Sponsored by:           Kumacom SAS
Differential Revision:  https://reviews.freebsd.org/D40685
This commit is contained in:
Olivier Certner 2023-06-20 22:09:57 +02:00 committed by Olivier Certner
parent 90e914cd5a
commit 97256feb7a
No known key found for this signature in database
GPG key ID: 8CA13040971E2627
1 changed files with 28 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
lib/libutil/login_cap.3
View file

@ -25,6 +25,7 @@
.Nm login_getcapbool ,
.Nm login_getcaplist ,
.Nm login_getcapnum ,
.Nm login_getcapenum ,
.Nm login_getcapstr ,
.Nm login_getcapsize ,
.Nm login_getcaptime ,
@ -60,6 +61,8 @@
.Fn login_getcaptime "login_cap_t *lc" "const char *cap" "rlim_t def" "rlim_t error"
.Ft rlim_t
.Fn login_getcapnum "login_cap_t *lc" "const char *cap" "rlim_t def" "rlim_t error"
.Ft int
.Fn login_getcapenum "login_cap_t *lc" "const char *cap" "const char * const *values"
.Ft rlim_t
.Fn login_getcapsize "login_cap_t *lc" "const char *cap" "rlim_t def" "rlim_t error"
.Ft int
@ -459,6 +462,31 @@ If the given capability tag cannot be found, the
parameter is returned, and if an error occurs, the
.Fa error
parameter is returned.
.It Fn login_getcapenum
This function returns whether the searched capability is a string with value
among a predefined set passed in argument
.Fa values
as a NULL-terminated array of strings.
.Pp
A non-negative value indicates a match and is the index of the capability's
value in array
.Fa values .
Other possible return values are:
.Bl -tag -width "-4"
.It -4
Returned if
.Fa lc
or
.Fa cap
are insufficiently initialized or invalid.
.It -3
Returned on allocation failure (out of memory).
.It -2
Returned if the capability isn't specified or its value is not a string.
.It -1
Returned if the capability is specified and a string but its value is not among
.Fa values .
.El
.It Fn login_getcapsize
.Fn login_getcapsize
returns a value representing a size (typically, file or memory)