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
56
57
58
59
60
61
62
63
64
|
# slow5_free_batch
## NAME
slow5_free_batch - frees up a slow5 record batch
## SYNOPSYS
`void slow5_free_batch(slow5_batch_t *read_batch)`
## DESCRIPTION
The `slow5_free_batch()` function frees the memory of a *slow5_batch_t* structure pointed by *read_batch*, which must have been returned by a previous call to `slow5_init_batch()`.
## RETURN VALUE
None
## EXAMPLES
```
#include <stdio.h>
#include <stdlib.h>
#include <slow5/slow5.h>
#include <slow5/slow5_mt.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 batch_size = 4096;
int num_thread = 8;
slow5_mt_t *mt = slow5_init_mt(num_thread,sp);
if (mt==NULL){ //currently not useful, but better have this for future proofing
fprintf(stderr,"Error in initialising multi-thread struct\n");
exit(EXIT_FAILURE);
}
slow5_batch_t *read_batch = slow5_init_batch(batch_size);
if (read_batch==NULL){ //currently not useful, but better have this for future proofing
fprintf(stderr,"Error in initialising slow5 record batch\n");
exit(EXIT_FAILURE);
}
// ...
slow5_free_batch(read_batch);
slow5_free_mt(mt);
slow5_close(sp);
return 0;
}
```
## SEE ALSO
[slow5_init_batch()](slow5_init_batch.md)
|
