obitools/obitools3
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 66 Wiki Activity

Standardized and improved the API to create new columns, updated the doc

Browse Source
This commit is contained in:
Celine Mercier
2017-07-18 17:34:32 +02:00
parent c88df2e12c
commit 59dd0a8a8c
4 changed files with 47 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/obiview.h
View File

@ -344,16 +344,20 @@ Obiview_p obi_open_view(OBIDMS_p dms, const char* view_name);
*
* @param view A pointer on the view.
* @param column_name The name of the column.
* @param version_number The version of the column if it should be opened and not created (if -1, the latest version is retrieved).
* @param version_number The version of the column if it should be opened and not created
* (if -1, the latest version is retrieved).
* @param alias The unique name used to identify the column in the context of this view.
* @param data_type The OBIType code of the data.
* @param nb_lines The number of lines to be stored.
* @param nb_elements_per_line The number of elements per line.
* If NULL or "", column_name is used.
* @param data_type The OBIType code of the data, if the column is created.
* @param nb_lines The number of lines to be stored (can be 0 if not known), if the column is created.
* @param nb_elements_per_line The number of elements per line, if the column is created.
* @param elements_names The names of the elements with ';' as separator (no terminal ';'),
* NULL or "" if the default names are to be used ("0;1;2;...;n").
* @param indexer_name The name of the indexer if there is one associated with the column.
* if the column is created; NULL or "" if the default names are to be used ("0\01\02\0...\0n").
* @param indexer_name The name of the indexer if there is one associated with the column, if the column is created.
* If NULL or "", the indexer name is set as the column name.
* @param comments Optional comments associated with the column if it is created.
* @param associated_column_name The name of the associated column if there is one (otherwise NULL or ""), if the column is created.
* @param associated_column_version The version of the associated column if there is one (otherwise -1), if the column is created.
* @param comments Optional comments associated with the column if it is created (NULL or "" if no comments associated).
* @param create Whether the column should be created (create == true) or opened (create == false).
*
* @returns A value indicating the success of the operation.