Elektra-keyname (3) Linux Manual Page

NAME

Key :: Name Manipulation Methods –

Methods to do various operations on Key names.

const char * keyName (const Key *key)

ssize_t keyGetNameSize (const Key *key)

ssize_t keyGetName (const Key *key, char *returnedName, size_t maxSize)

ssize_t keySetName (Key *key, const char *newName)

ssize_t keyGetFullNameSize (const Key *key)

ssize_t keyGetFullName (const Key *key, char *returnedName, size_t maxSize)

const char * keyBaseName (const Key *key)

ssize_t keyGetBaseNameSize (const Key *key)

ssize_t keyGetBaseName (const Key *key, char *returned, size_t maxSize)

ssize_t keyAddBaseName (Key *key, const char *baseName)

ssize_t keySetBaseName (Key *key, const char *baseName)

const char * keyOwner (const Key *key)

ssize_t keyGetOwnerSize (const Key *key)

ssize_t keyGetOwner (const Key *key, char *returned, size_t maxSize)

ssize_t keySetOwner (Key *key, const char *owner)

Methods to do various operations on Key names.

To use them:


#include <kdb.h>

These functions make it easier for c programmers to work with key names. Everything here can also be done with keySetName, described in key.

Rules for Key Names.RS 4

When using Elektra to store your application’s configuration and state, please keep in mind the following rules:

*: You are not allowed to create keys right under system or user.
*: You are not allowed to create folder keys right under system or user. They are reserved for very essential OS subsystems.
*: The keys for your application, called say MyApp, should be created under system/sw/MyApp and/or user/sw/MyApp.
*: It is suggested to make your application look for default keys under system/sw/MyApp/current and/or user/sw/MyApp/current. This way, from a sysadmin perspective, it will be possible to copy the system/sw/MyApp/current tree to something like system/sw/MyApp/old, and keep system clean and organized.
*