Functions | |
int | keyNeedStat (const Key *key) |
int | keyNeedSync (const Key *key) |
int | keyNeedRemove (const Key *key) |
int | keyIsSystem (const Key *key) |
int | keyIsUser (const Key *key) |
int | keyIsBelow (const Key *key, const Key *check) |
int | keyIsDirectBelow (const Key *key, const Key *check) |
int | keyIsInactive (const Key *key) |
int | keyIsDir (const Key *key) |
int | keyIsBinary (const Key *key) |
int | keyIsString (const Key *key) |
To use them:
#include <kdb.h>
int keyIsBelow | ( | const Key * | key, | |
const Key * | check | |||
) |
Check if the key check is below the key key or not.
Example: key user/sw/app check user/sw/app/key returns true because check is below key Example: key user/sw/app check user/sw/app/folder/key returns also true because check is indirect below key
key | the key object to work with | |
check | the key to find the relative position of |
0 if it is not below or if it is the same key
int keyIsBinary | ( | const Key * | key | ) |
Check if a key is binary type.
The function checks if the keytype is in the range between KEY_TYPE_BINARY and less than excluding KEY_TYPE_STRING. Then it will be interpreted as binary.
Make sure to use this function and don't test the binary type another way to ensure compatibility and to write less error prone programs.
0 if it is not
-1 on NULL pointer
key | the key to check |
int keyIsDir | ( | const Key * | key | ) |
Check if a key is directory key.
Folder keys may also have value and comment. They are discern by having a executable bit set.
If any executable bit is set it will be recognized as a directory.
Accessing does not mean that you can get any value or comments below, see Mode for more information.
key | the key object to work with |
-1 on NULL pointer
int keyIsDirectBelow | ( | const Key * | key, | |
const Key * | check | |||
) |
Check if the key check is direct below the key key or not.
Example: key user/sw/app check user/sw/app/key returns true because check is below key Example: key user/sw/app check user/sw/app/folder/key does not return true, because there is only a indirect relation
key | the key object to work with | |
check | the key to find the relative position of |
0 if it is not below or if it is the same key
-1 on null pointer
int keyIsInactive | ( | const Key * | key | ) |
Check whether a key is inactive or not.
In elektra terminology any key is inactive if the it's basename starts with '.'. Inactive keys must not have any meaning to applications, they are reserved for users and administrators.
To remove a whole hierarchy in elektra, don't forget to pass option_t::KDB_O_INACTIVE to kdbGet() to receive the inactive keys in order to remove them.
Otherwise you should not fetch these keys.
key | the key object to work with |
-1 on NULL pointer or when key has no name
int keyIsString | ( | const Key * | key | ) |
Check if a key is string type.
The function checks if the keytype is larger or equal KEY_TYPE_STRING. Then it will be considered as string type.
Make sure to use this function and don't test the string type another way to ensure compatibility and to write less error prone programs.
0 if it is not
-1 on NULL pointer
key | the key to check |
int keyIsSystem | ( | const Key * | key | ) |
Check whether a key is under the system
namespace or not
key | the key object to work with |
system
, 0 otherwise -1 on NULL pointer
int keyIsUser | ( | const Key * | key | ) |
Check whether a key is under the user
namespace or not.
key | the key object to work with |
user
, 0 otherwise -1 on NULL pointer
int keyNeedRemove | ( | const Key * | key | ) |
Ask if key is marked for permanent remove.
Ask if the key will be removed instead of writing in the key database when doing kdbSetKey() or kdbSet().
key | the key object to work with |
-1 on NULL pointer
int keyNeedStat | ( | const Key * | key | ) |
Ask if key is marked for stat only.
Ask if the key will be stat instead of get it from the key database completely doing kdbGetKey() or kdbGet(). This is useful if you are not interested in the value, comment or key type.
key | the key object to work with |
-1 on NULL pointer
int keyNeedSync | ( | const Key * | key | ) |
Test if a key needs to be synced to backend storage.
If any key modification took place the key will be flagged with KEY_FLAG_SYNC so that kdbSet() knows which keys were modified and which not.
After keyNew() the flag will normally be set, but after kdbGet() and kdbSet() the flag will be removed. When you modify the key the flag will be set again.
In your application you can make use of that flag to know if you changed something in a key after a kdbGet() or kdbSet().
key | the key object to work with |
key
was changed in memory, 0 otherwise -1 on NULL pointer