xref: /illumos-gate/usr/src/man/man9f/priv_getbyname.9f (revision 06ca4e396ecc93ed45a333664a51558b7e84e8f5)
te
Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
PRIV_GETBYNAME 9F "Mar 11, 2004"
NAME
priv_getbyname - map a privilege name to a number
SYNOPSIS
#include <sys/cred.h>



int priv_getbyname(const char *priv, int flags);
INTERFACE LEVEL
illumos DDI specific (illumos DDI).
PARAMETERS
priv

name of the privilege

flags

flags, must be zero or PRIV_ALLOC

DESCRIPTION
The priv_getbyname() function maps a privilege name to a privilege number for use with the priv_*() kernel interfaces.

If PRIV_ALLOC is passed as a flag parameter, an attempt is made to allocate a privilege if it is not yet defined. The newly allocated privilege number is returned.

Privilege names can be specified with an optional priv_ prefix, which is stripped.

Privilege names are case insensitive but allocated privileges preserve case.

Allocated privileges can be at most {PRIVNAME_MAX} characters long and can contain only alphanumeric characters and the underscore character.

RETURN VALUES
This function returns the privilege number, which is greater than or equal to 0, if it succeeds. It returns a negative error number if an error occurs.
ERRORS
EINVAL

This might be caused by any of the following

The flags parameter is invalid.

The specified privilege does not exist.

The priv parameter contains invalid characters.

ENOMEM

There is no room to allocate another privilege.

ENAMETOOLONG

An attempt was made to allocate a privilege that was longer than {PRIVNAME_MAX} characters.

CONTEXT
This functions can be called from user and kernel contexts.
ATTRIBUTES
See attributes(7) for a description of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
Architecture All
Interface Stability Committed
SEE ALSO
attributes (7), privileges (7)

Writing Device Drivers