File: slow5_set_log_level.md

package info (click to toggle)
libslow5lib 0.7.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 25,092 kB
  • sloc: ansic: 11,825; python: 1,179; sh: 547; makefile: 91; cpp: 40
file content (54 lines) | stat: -rwxr-xr-x 1,125 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
# slow5_set_log_level

## NAME

slow5_set_log_level - sets the level log message verbosity

## SYNOPSYS

`void slow5_set_log_level(enum slow5_log_level_opt log_level)`

## DESCRIPTION

`slow5_set_log_level()` sets the level of verbosity in the slow5lib log messages as specified by *log_level*. *log_level* can be one of the following:

- `SLOW5_LOG_OFF`:  nothing at all
- `SLOW5_LOG_ERR`:  error messages
- `SLOW5_LOG_WARN`: warning and error messages
- `SLOW5_LOG_INFO`: information, warning and error messages (default)
- `SLOW5_LOG_VERB`: verbose, information, warning and error messages
- `SLOW5_LOG_DBUG`: debugging, verbose, information, warning and error messages

If `slow5_set_log_level` is not invoked,  default value is `SLOW5_LOG_INFO`.

## RETURN VALUE

None.

## ERRORS

None.


## NOTES

Internally sets global variable. Intended to be set as the beginning of the programme.

## EXAMPLES

```
#include <stdio.h>
#include <stdlib.h>
#include <slow5/slow5.h>

int main(){

	slow5_set_log_level(SLOW5_LOG_DBUG);

	//... do the rest

}
```

## SEE ALSO
[slow5_set_exit_condition()](slow5_set_exit_condition.md).