1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
# slow5_idx_create
## NAME
slow5_idx_create - creates an index file for a SLOW5 file
## SYNOPSYS
`int slow5_idx_create(slow5_file_t *s5p)`
## DESCRIPTION
Creates an index file to a SLOW5 file pointed by *s5p* to enable random access (based on read ID) to the SLOW5 file. Overwrites if the index file already exists.
## RETURN VALUE
Upon successful completion, `slow5_idx_create()` returns a non-negative integer. Otherwise, a negative value is returned.
## NOTES
`slow5_errno` will be set in future to indicate the type of error that occurred.
## EXAMPLES
```
#include <stdio.h>
#include <stdlib.h>
#include <slow5/slow5.h>
#define FILE_PATH "examples/example.slow5"
int main(){
slow5_file_t *sp = slow5_open(FILE_PATH,"r");
if(sp==NULL){
fprintf(stderr,"Error in opening file\n");
exit(EXIT_FAILURE);
}
int ret=0;
ret = slow5_idx_create(sp);
if(ret<0){
fprintf(stderr,"Error in creating index\n");
exit(EXIT_FAILURE);
}
slow5_close(sp);
}
```
## SEE ALSO
[slow5_idx_load()](slow5_idx_load.md), [`slow5_idx_unload()`](slow5_idx_unload.md)
|
