Browse Source

Complete documentation of public header

redesign
Pradana AUMARS 10 months ago
parent
commit
1156c9debf
  1. 66
      include/easycsv.h

66
include/easycsv.h

@ -40,7 +40,7 @@ easycsv_init_errormsg(const char*,
void
easycsv_free(easycsv*);
/*** Access ***/
/*** Access, find ***/
/**
* Find value and returns row and column
@ -66,6 +66,8 @@ int
easycsv_findnumvalue(const easycsv*,
const char*);
/*** Access, read ***/
/**
* Read string in a specific cell
* @param[in] constant pointer to easycsv structure
@ -90,6 +92,8 @@ easycsv_readcolumnvalue(const easycsv*,
const char*,
unsigned int);
/*** Access, print ***/
/**
* Return number of rows
* @param[in] constant pointer to easycsv structure
@ -206,33 +210,59 @@ easycsv_insertcolumnvaluemode(easycsv*,
const char*,
EASYCSV_VALMODE);
/* Modifications, push */
/*** Modifications, push ***/
/* Create new column on the RHS of an existing one */
/**
* Create new column on the right-hand side of an existing one
* @param[in] pointer to easycsv structure
* @param[in] column value
* @return easycsv error code
*/
int
easycsv_pushcolumn(easycsv*,
const char*);
/* Insert string in a vacant cell under a named column */
/**
* Insert string in a vacant cell under a named column
* @param[in] pointer to easycsv structure
* @param[in] column value
* @param[in] cell value
* @return easycsv error code
*/
int
easycsv_pushcolumnvalue(easycsv*,
const char*,
const char*);
/* Modifications, delete */
/*** Modifications, delete ***/
/* Delete CSV value */
/**
* Delete cell value
* @param[in] pointer to easycsv structure
* @param[in] row number
* @param[in] column number
* @return easycsv error code
*/
int
easycsv_deletevalue(easycsv*,
const unsigned int,
const unsigned int);
unsigned int,
unsigned int);
/* Delete numbered column */
/**
* Delete numbered column
* @param[in] pointer to easycsv structure
* @param[in] column number
* @return easycsv error code
*/
int
easycsv_deletecolumnint(easycsv*,
const unsigned int);
unsigned int);
/* Delete named column */
/** Delete named column
* @param[in] pointer to easycsv structure
* @param[in] column value
* @return easycsv error code
*/
int
easycsv_deletecolumnstr(easycsv*,
const char*);
@ -241,15 +271,25 @@ easycsv_deletecolumnstr(easycsv*,
/* Delete named row */
/*** Modifications, append ***/
/* Modifications, append */
/**
* Append two CSV files
* @param[in] destination CSV file
* @param[in] source CSV file
* @return easycsv error code
*/
int
easycsv_appendcsv(easycsv*,
easycsv*);
/*** Modifications, miscellenaeous ***/
/**
* Compress a CSV file
* @param[in] pointer to easycsv structure
* @return easycsv error code
*/
int
easycsv_compress(easycsv*);

Loading…
Cancel
Save