NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | LINKING | SEE ALSO | COLOPHON

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

NAME         top

       keyctl_clear - Clear a keyring

SYNOPSIS         top

       #include <keyutils.h>

       long keyctl_clear(key_serial_t keyring);

DESCRIPTION         top

       keyctl_clear() clears the contents of a keyring.

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

RETURN VALUE         top

       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         top

       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         top

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

SEE ALSO         top

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

COLOPHON         top

       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 2016-09-01.  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)