MIKAI
Library to modify content of a Mykey
Macros | Typedefs | Functions
mikai-reader.h File Reference
#include <stdlib.h>

Go to the source code of this file.

Macros

#define MIKAI_EXPORT
 

Typedefs

typedef struct MyKey MyKey
 

Functions

size_t MyKeyGetReadersCount (MyKey *key)
 Update internal register of available readers. More...
 
char * MyKeyGetReaderDescription (MyKey *key, int reader)
 Get the description of a reader. More...
 
int MyKeyWriteAll (MyKey *key)
 Write all modified blocks to SRIX4K. More...
 

Macro Definition Documentation

◆ MIKAI_EXPORT

#define MIKAI_EXPORT

Definition at line 35 of file mikai-reader.h.

Typedef Documentation

◆ MyKey

typedef struct MyKey MyKey

Definition at line 26 of file mikai-reader.h.

Function Documentation

◆ MyKeyGetReaderDescription()

char* MyKeyGetReaderDescription ( MyKey key,
int  reader 
)

Get the description of a reader.

Parameters
keypointer to MyKey instance where readers are saved
readeroffset of reader to get
Returns
string description of reader

◆ MyKeyGetReadersCount()

size_t MyKeyGetReadersCount ( MyKey key)

Update internal register of available readers.

Parameters
keypointer to MyKey instance where save readers
Returns
number of available readers

◆ MyKeyWriteAll()

int MyKeyWriteAll ( MyKey key)

Write all modified blocks to SRIX4K.

Parameters
keypointer to MyKey instance where reader is initialized
Returns
0 = success: if it's another value, use MikaiGetLatestError()