Skip to content

Commit 172a795

Browse files
committed
C API and validation documented
1 parent 37f9383 commit 172a795

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

c/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,27 +20,27 @@ contents of the XDI file along with a few particularly important items
2020

2121
| attribute | type | explanation |
2222
| --------------- | ------------------ | ----------- |
23+
| filename | char* | the name of the XDI file |
2324
| nmetadata | long | number of metadata fields |
25+
| meta\_families | array of char* | array of family names found among the metadata, indexed to nmetadata |
26+
| meta\_keywords | array of char* | array of keyword names found among the metadata, indexed to nmetadata |
27+
| meta\_values | array of char* | array of values found among the metadata, indexed to nmetadata |
2428
| narrays | long | number of arrays in data table |
2529
| npts | long | number of rows in data table |
30+
| array | of array of double | the data table |
2631
| narray\_labels | long | number of array labels |
27-
| error\_lineno | long | the line number of a line returning an error |
28-
| dspacing | double | the Mono.d-spacing value |
32+
| array\_labels | array of char* | array of labels for arrays in the data table |
33+
| array\_units | array of char* | array of units for arrays in the data table |
34+
| comments | char* | the user supplied comments from the XDI file |
2935
| xdi\_libversion | char* | the `libxdifile` version number |
3036
| xdi\_version | char* | the XDI file specification version number from the file |
3137
| extra\_version | char* | versioning information for extension fields |
32-
| filename | char* | the name of the XDI file |
33-
| element | char* | the 1, 2, or 3 letter symbol of the element |
34-
| edge | char* | the 1 or 2 letter symbol of the edge |
35-
| comments | char* | the user supplied comments from the XDI file |
38+
| dspacing | double | the Mono.d-spacing value |
39+
| element | char* | the Element.symbol value, the 1, 2, or 3 letter symbol of the element |
40+
| edge | char* | the Element.edge value, the the 1 or 2 letter symbol of the edge |
41+
| error\_lineno | long | the line number of a line returning an error |
3642
| error\_line | char* | the line returning an error |
3743
| error\_message | char* | the error message |
38-
| array\_labels | array of char* | array of labels for arrays in the data table |
39-
| array\_units | array of char* | array of units for arrays in the data table |
40-
| meta\_families | array of char* | array of family names found among the metadata, indexed to nmetadata |
41-
| meta\_keywords | array of char* | array of keyword names found among the metadata, indexed to nmetadata |
42-
| meta\_values | array of char* | array of values found among the metadata, indexed to nmetadata |
43-
| array | of array of double | the data table |
4444
| nouter | long | |
4545
| outer\_label | array char* | |
4646
| outer\_array | array of double | |

0 commit comments

Comments
 (0)