core
/
eccodes
mirror of https://github.com/ecmwf/eccodes.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation and function argument naming

This commit is contained in:
Shahram Najm 2017-09-25 16:32:51 +01:00
parent 3947f5e632
commit f4c53833b0
3 changed files with 29 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/eccodes.c
View File

@ -349,9 +349,9 @@ int codes_get_string(grib_handle* h, const char* key, char* mesg, size_t *length
{
return grib_get_string(h,key,mesg,length);
}
int codes_get_string_array(grib_handle* h, const char* name, char** val, size_t *length)
int codes_get_string_array(grib_handle* h, const char* key, char** vals, size_t *length)
{
return grib_get_string_array(h,name,val,length);
return grib_get_string_array(h,key,vals,length);
}
int codes_get_bytes(grib_handle* h, const char* key, unsigned char* bytes, size_t *length)
{

22
src/eccodes.h
View File

@ -798,7 +798,17 @@ int codes_get_double_elements(codes_handle* h, const char* key, int* i, long siz
*/
int codes_get_string(codes_handle* h, const char* key, char* mesg, size_t *length );
int codes_get_string_array(codes_handle* h, const char* name, char** val, size_t *length);
/**
* Get string array values from a key. If several keys of the same name are present, the last one is returned
* @see codes_set_string_array
*
* @param h : the handle to get the data from
* @param key : the key to be searched
* @param vals : the address of a string array where the data will be retrieved
* @param length : the address of a size_t that contains allocated length of the array on input, and that contains the actual length of the array on output
* @return 0 if OK, integer value on error
*/
int codes_get_string_array(codes_handle* h, const char* key, char** vals, size_t *length);
/**
* Get raw bytes values from a key. If several keys of the same name are present, the last one is returned
@ -816,11 +826,11 @@ int codes_get_bytes(codes_handle* h, const char* key, unsigned char* bytes, size
* Get double array values from a key. If several keys of the same name are present, the last one is returned
* @see codes_set_double_array
*
* @param h : the handle to get the data from
* @param key : the key to be searched
* @param vals : the address of a double array where the data will be retrieved
* @param length : the address of a size_t that contains allocated length of the double array on input, and that contains the actual length of the double array on output
* @return 0 if OK, integer value on error
* @param h : the handle to get the data from
* @param key : the key to be searched
* @param vals : the address of a double array where the data will be retrieved
* @param length : the address of a size_t that contains allocated length of the double array on input, and that contains the actual length of the double array on output
* @return 0 if OK, integer value on error
*/
int codes_get_double_array(codes_handle* h, const char* key, double* vals, size_t *length);

12
src/grib_api.h
View File

@ -816,7 +816,17 @@ int grib_get_double_elements(grib_handle* h, const char* key, int* i, long size,
*/
int grib_get_string(grib_handle* h, const char* key, char* mesg, size_t *length);
int grib_get_string_array(grib_handle* h, const char* name, char** val, size_t *length);
/**
* Get string array values from a key. If several keys of the same name are present, the last one is returned
* @see grib_set_string_array
*
* @param h : the handle to get the data from
* @param key : the key to be searched
* @param vals : the address of a string array where the data will be retrieved
* @param length : the address of a size_t that contains allocated length of the array on input, and that contains the actual length of the array on output
* @return 0 if OK, integer value on error
*/
int grib_get_string_array(grib_handle* h, const char* key, char** vals, size_t *length);
/**
* Get raw bytes values from a key. If several keys of the same name are present, the last one is returned