KEYCTL_CLEAR - clear a keyring

NAME  LIBRARY  SYNOPSIS  DESCRIPTION  RETURN VALUE  VERSIONS  STANDARDS  HISTORY  SEE ALSO 

---

NAME

KEYCTL_CLEAR − clear a keyring

LIBRARY

Standard C library (libc, −lc)

SYNOPSIS

#include <linux/keyctl.h> /* Definition of KEY* constants */
#include <sys/syscall.h> /* Definition of SYS_* constants */
#include <unistd.h>

long syscall(SYS_keyctl, KEYCTL_CLEAR, key_serial_t key);

DESCRIPTION

Clear the contents of (i.e., unlink all keys from) a keyring.

The ID of the key (which must be of keyring type) is provided in key.

The caller must have write permission on the keyring.

RETURN VALUE

On success, 0 is returned.

On error, −1 is returned, and errno is set to indicate the error.

VERSIONS

A wrapper is provided in the libkeyutils library: keyctl_clear(3).

STANDARDS

Linux.

HISTORY

Linux 2.6.10.

SEE ALSO

keyctl(2), keyctl_clear(3)

---