forked from EarthScope/libmseed
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathms_parse_raw.3
46 lines (38 loc) · 1.32 KB
/
ms_parse_raw.3
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
.TH MSR_PARSE 3 2010/12/30 "Libmseed API"
.SH NAME
msr_parse - Parse, validate and print details of a SEED data record
.SH SYNOPSIS
.nf
.B #include <libmseed.h>
.BI "int \fBms_parse_raw\fP ( char *" record ", int " maxreclen ","
.BI " flag " details ", flag " swapflag " );"
.fi
.SH DESCRIPTION
\fBms_parse_raw\fP is a simple validating SEED data record header
parser. The data in \fIrecord\fP is assumed to contain a SEED data
record with a maximum length of \fImaxreclen\fP. In addition to
validating header fields where possible, raw header fields can be
printed. This routine is primarily intended for identifying invalid
data record headers and printing record header contents.
The \fIdetails\fP flag is interpreted as follows:
.nf
0 = only print error messages for invalid header fields
1 = print basic fields in addition to invalid field errors
2 = print all fields in addition to invalid field errors
.fi
The \fIswapflag\fP flag is interpreted as follows:
.nf
1 = swap multibyte quantities
0 = do no swapping
-1 = autodetect byte order using year test, swap if needed
.fi
.SH RETURN VALUES
\fBms_parse_raw\fP returns 0 when no errors were detected or a
positive count of errors detected.
.SH SEE ALSO
\fBmsr_parse(3)\fP and \fBms_detect(3)\fP
.SH AUTHOR
.nf
Chad Trabant
IRIS Data Management Center
.fi