Table key-data-mapping


Defines

#define IX_KEY_LEN   54
 length of key
#define IX_DATA_LEN   447
 length of data

Functions

int ix_key_sizeofkey (void)
int ix_key_sizeofdata (void)
int ix_key_env_get (char *key, char *buffer, int bufferlen)
int ix_key_env_set (char *key, char *buffer)
int ix_key_env_unset (char *key)
int ix_key_file_get (char *path, char *key, char *buffer, int bufferlen, int *pflag)
int ix_key_file_set (char *path, char *key, char *buffer, int flag)
int ix_key_file_unset (char *path, char *key)
int ix_key_file_clear (char *path)

Detailed Description

This module deals with stored key string-data mapping

Function Documentation

int ix_key_env_get ( char *  key,
char *  buffer,
int  bufferlen 
)

reads key related data from environment to buffer

Parameters:
key key of data
buffer where data is stored
bufferlen length of data storage buffer
Returns:
  • length of data
  • <0: Error

int ix_key_env_set ( char *  key,
char *  buffer 
)

set key related data in environment

Parameters:
key key of data
buffer zero terminated data buffer
Returns:
  • 0: OK
  • !0: error

int ix_key_env_unset ( char *  key  ) 

unset key related data in environment

Parameters:
key key of data
Returns:
  • 0: OK
  • !0: error

int ix_key_file_clear ( char *  path  ) 

clear table/file related data

Parameters:
path absolute path of a file the key data mapping is stored
Returns:
  • 0: OK
  • !0: error

int ix_key_file_get ( char *  path,
char *  key,
char *  buffer,
int  bufferlen,
int *  pflag 
)

reads key and table/file related data and flag from file to buffer

Parameters:
path absolute path of a file to store the key data mapping
key key of data
buffer where data is stored
bufferlen length of data storage buffer
pflag place to store the flag
Returns:
  • length of data
  • <0: Error

int ix_key_file_set ( char *  path,
char *  key,
char *  buffer,
int  flag 
)

stores key and table/file related data and flag in file

Parameters:
path absolute path of a file the key data mapping is stored
key key of data
buffer zero terminated data buffer
flag bitfield as integer to store with data
Returns:
  • 0: OK
  • !0: error

int ix_key_file_unset ( char *  path,
char *  key 
)

unset key and table/file related data and flag in file

Parameters:
path absolute path of a file the key data mapping is stored
key key of data
Returns:
  • 0: OK
  • !0: error

int ix_key_sizeofdata ( void   ) 

returns maximal size of data

int ix_key_sizeofkey ( void   ) 

returns maximal size of key


Generated on 4 Mar 2014 for ixtools by  doxygen 1.4.7