Manual Reference Pages  - KEYCTL_CLEAR (3)

NAME

keyctl_clear - Clear a keyring

CONTENTS

Synopsis
Description
Return Value
Errors
Linking
See Also

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 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_get_keyring_ID(3),
keyctl_join_session_keyring(3),
keyctl_update(3),
keyctl_revoke(3),
keyctl_chown(3),
keyctl_setperm(3),
keyctl_describe(3),
keyctl_link(3),
keyctl_unlink(3),
keyctl_search(3),
keyctl_read(3),
keyctl_instantiate(3),
keyctl_negate(3),
keyctl_set_reqkey_keyring(3),
keyctl_set_timeout(3),
keyctl_assume_authority(3),
keyctl_describe_alloc(3),
keyctl_read_alloc(3),
request-key(8)


Linux KEYCTL_CLEAR (3) 4 May 2006
blog comments powered by Disqus