Skip to content
This repository has been archived by the owner on Oct 15, 2024. It is now read-only.

Commit

Permalink
doc: types from #1388
Browse files Browse the repository at this point in the history
  • Loading branch information
Markus Raab committed Mar 4, 2017
1 parent 8c7a39b commit 6f074b5
Showing 1 changed file with 19 additions and 14 deletions.
33 changes: 19 additions & 14 deletions doc/decisions/high_level_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,20 +46,25 @@ First draft of API:
// might fail, you need to check for error afterwards!
Elektra * elektraOpen (const char * application);

// enum, int, tristate
int elektraGetInt (Elektra * handle, const char * name);

char * elektraGetString (Elektra * handle, const char * name);

// and so on.. (all types)


// are arrays already advanced functionality? (recursive API)

// enum, int, tristate
int elektraGetIntArray (Elektra * handle, const char * name, int elem);

int elektraGetArraySize (Elektra * handle, const char * name);
// getters
kdb_string_t kdbhlGetString (KDBHL * kdbhl, const char * name);
kdb_boolean_t kdbhlGetBoolean (KDBHL * kdbhl, const char * name);
kdb_char_t kdbhlGetChar (KDBHL * kdbhl, const char * name);
kdb_octet_t kdbhlGetOctet (KDBHL * kdbhl, const char * name);
kdb_short_t kdbhlGetShort (KDBHL * kdbhl, const char * name);
kdb_unsigned_short_t kdbhlGetUnsignedShort (KDBHL * kdbhl, const char * name);
kdb_long_t kdbhlGetLong (KDBHL * kdbhl, const char * name);
kdb_unsigned_long_t kdbhlGetUnsignedLong (KDBHL * kdbhl, const char * name);
kdb_long_long_t kdbhlGetLongLong (KDBHL * kdbhl, const char * name);
kdb_unsigned_long_long_t kdbhlGetUnsignedLongLong (KDBHL * kdbhl, const char * name);
kdb_float_t kdbhlGetFloat (KDBHL * kdbhl, const char * name);
kdb_double_t kdbhlGetDouble (KDBHL * kdbhl, const char * name);
kdb_long_double_t kdbhlGetLongDouble (KDBHL * kdbhl, const char * name);

// arrays
kdb_long_t elektraGetArrayLong (Elektra * handle, const char * name, size_t elem);

size_t elektraGetArraySize (Elektra * handle, const char * name);

void elektraClose (Elektra * handle);
```
Expand Down

0 comments on commit 6f074b5

Please sign in to comment.