keyctl_clear(3) — Linux manual page

KEYCTL_CLEAR(3)        Linux Key Management Calls        KEYCTL_CLEAR(3)

NAME

       keyctl_clear - clear a keyring

SYNOPSIS

       #include <keyutils.h>

       long keyctl_clear(key_serial_t keyring);

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

       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

       ENOKEY The keyring specified is invalid.

       EKEYEXPIRED
              The keyring specified has expired.

       EKEYREVOKED
              The keyring specified had been revoked.

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

LINKING

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

SEE ALSO

       keyctl(1), add_key(2), keyctl(2), request_key(2), keyctl(3),
       keyrings(7), keyutils(7)

COLOPHON

       This page is part of the keyutils (key management utilities)
       project.  Information about the project can be found at [unknown
       -- if you know, please contact man-pages@man7.org] If you have a
       bug report for this manual page, send it to
       keyrings@linux-nfs.org.  This page was obtained from the
       project's upstream Git repository
       ⟨http://git.kernel.org/pub/scm/linux/kernel/git/dhowells/keyutils.git⟩
       on 2024-06-14.  (At that time, the date of the most recent commit
       that was found in the repository was 2023-03-20.)  If you
       discover any rendering problems in this HTML version of the page,
       or you believe there is a better or more up-to-date source for
       the page, or you have corrections or improvements to the
       information in this COLOPHON (which is not part of the original
       manual page), send a mail to man-pages@man7.org

Linux                          4 May 2006                KEYCTL_CLEAR(3)

Pages that refer to this page: keyctl(2), keyctl(3), keyrings(7)

---