KEYCTL\_CLEAR(3) Linux Key Management Calls KEYCTL\_CLEAR(3)

# [NAME](#NAME)

keyctl\_clear - clear a keyring

# [SYNOPSIS](#SYNOPSIS)

```
#include <keyutils.h>

long keyctl_clear(key_serial_t keyring);
```

# [DESCRIPTION](#DESCRIPTION)

**keyctl\_clear**() clears the contents of a *keyring*.

The caller must have **write** permission on a keyring to be able to clear it.

# [RETURN VALUE](#RETURN_VALUE)

On success **keyctl\_clear**() returns **0**. On error, the value **-1** will be returned and *errno* will have been set to an appropriate error.

# [ERRORS](#ERRORS)

[**ENOKEY**](#ENOKEY)

The keyring specified is invalid.

[**EKEYEXPIRED**](#EKEYEXPIRED)

The keyring specified has expired.

[**EKEYREVOKED**](#EKEYREVOKED)

The keyring specified had been revoked.

[**EACCES**](#EACCES)

The keyring exists, but is not **writable** by the calling process.

# [LINKING](#LINKING)

This is a library function that can be found in *libkeyutils*. When linking, **-lkeyutils** should be specified to the linker.

# [SEE ALSO](#SEE_ALSO)

[**keyctl**(1)](/man/os/keyutils/keyctl.1), [**add\_key**(2)](/man/os/keyutils/add_key.2), [**keyctl**(2)](/man/os/keyutils/keyctl.2), [**request\_key**(2)](/man/os/keyutils/request_key.2), [**keyctl**(3)](/man/os/keyutils/keyctl.3), [**keyrings**(7)](/man/os/keyutils/keyrings.7), [**keyutils**(7)](/man/os/keyutils/keyutils.7)

4 May 2006 Linux

---

Document: keyctl_clear(3) from keyutils 1.6.3-r40 (Chainguard OS)
Source: https://kernel.googlesource.com/pub/scm/linux/kernel/git/dhowells/keyutils.git
