File: slow5_idx_unload.md

package info (click to toggle)
libslow5lib 0.7.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 25,092 kB
  • sloc: ansic: 11,825; python: 1,179; sh: 547; makefile: 91; cpp: 40
file content (55 lines) | stat: -rw-r--r-- 1,066 bytes parent folder | download | duplicates (2)
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
50
51
52
53
54
55
# slow5_idx_unload

## NAME
slow5_idx_unload - unloads a SLOW5 index from the memory

## SYNOPSYS
`void slow5_idx_unload(slow5_file_t *s5p)`

## DESCRIPTION
`slow5_idx_unload()` unloads an index file loaded into memory for a SLOW5 file pointed by *s5p*, which must have been previously loaded using `slow5_idx_load()`. Otherwise, or if *slow5_idx_unload(s5p)* has already been called before, undefined behaviour occurs.

## RETURN VALUE

No return value


## NOTES


## 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_load(sp);
    if(ret<0){
        fprintf(stderr,"Error in loading index\n");
        exit(EXIT_FAILURE);
    }

    //...

    slow5_idx_unload(sp);

    slow5_close(sp);

}
```

## SEE ALSO

[slow5_idx_create()](slow5_idx_create.md), [slow5_idx_load()](slow5_idx_load.md)