table of contents
| owner.c(3elektra) | Elektra | owner.c(3elektra) |
NAME¶
owner.c - Obsolete owner methods.
SYNOPSIS¶
#include <kdb.h>
#include <kdbconfig.h>
#include <kdbmeta.h>
#include <kdbprivate.h>
Functions¶
const char * keyOwner (const Key *key)
Return a pointer to the real internal key owner. " ssize_t
keyGetOwnerSize (const Key *key)
Return the size of the owner of the Key with concluding 0. " ssize_t
keyGetOwner (const Key *key, char *returnedOwner, size_t maxSize)
Return the owner of the key. ssize_t keySetOwner (Key *key, const char
*newOwner)
Set the owner of a key.
Detailed Description¶
Obsolete owner methods.
Copyright:
Function Documentation¶
ssize_t keyGetOwner (const Key * key, char * returnedOwner, size_t maxSize)¶
Return the owner of the key.
- Given user:someuser/..... return someuser
- Given user:some.user/.... return some.user
- Given user/.... return the current user
Only user/... keys have a owner. For system/... keys (that doesn't have a key owner) an empty string ('') is returned.
Although usually the same, the owner of a key is not related to its UID. Owner are related to WHERE the key is stored on disk, while UIDs are related to mode controls of a key.
Parameters:
returnedOwner a pre-allocated space to store the owner
maxSize maximum number of bytes that fit returned
Returns:
Return values:
-1 on NULL pointers
-1 when maxSize is 0, larger than SSIZE_MAX or too small for ownername
See also:
ssize_t keyGetOwnerSize (const Key * key)¶
Return the size of the owner of the Key with concluding 0. The returned number can be used to allocate a string. 1 will returned on an empty owner to store the concluding 0 on using keyGetOwner().
char * buffer; buffer = elektraMalloc (keyGetOwnerSize (key)); // use buffer and keyGetOwnerSize (key) for maxSize
Note:
Parameters:
Returns:
Return values:
-1 on NULL pointer
See also:
const char* keyOwner (const Key * key)¶
Return a pointer to the real internal key owner. This is a much more efficient version of keyGetOwner() and you should use it if you are responsible enough to not mess up things. You are not allowed to modify the returned string in any way. If you need a copy of the string, consider to use keyGetOwner() instead.
keyOwner() returns '' when there is no keyOwner. The reason is
key=keyNew(0); keySetOwner(key,""); keyOwner(key); // you would expect "" here keySetOwner(key,"system"); keyOwner(key); // you would expect "" here
Note:
Parameters:
Returns:
Return values:
0 iff key is a NULL pointer
See also:
keyGetOwner(), keySetOwner()
keyName() for name without owner
keyGetFullName() for name with owner
ssize_t keySetOwner (Key * key, const char * newOwner)¶
Set the owner of a key. A owner is a name of a system user related to a UID. The owner decides on which location on the disc the key goes.
A private copy is stored, so the passed parameter can be freed after the call.
Parameters:
newOwner the string which describes the owner of the key
Returns:
Return values:
-1 on null pointer or memory problems
See also:
Author¶
Generated automatically by Doxygen for Elektra from the source code.
| Mon Jan 15 2018 | Version 0.8.20 |