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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
.\" header.tmac. GetData manual macros.
.\"
.\" Copyright (C) 2016 D. V. Wiebe
.\"
.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.\"
.\" This file is part of the GetData project.
.\"
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.2 or
.\" any later version published by the Free Software Foundation; with no
.\" Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
.\" Texts. A copy of the license is included in the `COPYING.DOC' file
.\" as part of this distribution.
.\" Format a function name with optional trailer: func_name()trailer
.de FN \" func_name [trailer]
.nh
.BR \\$1 ()\\$2
.hy
..
.\" Format a reference to section 3 of the manual: name(3)trailer
.de F3 \" func_name [trailer]
.nh
.BR \\$1 (3)\\$2
.hy
..
.\" Format the header of a list of definitons
.de DD \" name alt...
.ie "\\$2"" \{ \
.TP 8
.PD
.B \\$1 \}
.el \{ \
.PP
.B \\$1
.PD 0
.DD \\$2 \\$3 \}
..
.\" Start a code block: Note: groff defines an undocumented .SC for
.\" Bell Labs man legacy reasons.
.de SC
.fam C
.na
.nh
..
.\" End a code block
.de EC
.hy
.ad
.fam
..
.\" Format a structure pointer member: struct->member\fRtrailer
.de SPM \" struct member trailer
.nh
.ie "\\$3"" .IB \\$1 ->\: \\$2
.el .IB \\$1 ->\: \\$2\fR\\$3
.hy
..
.\" Format a function argument
.de ARG \" name trailer
.nh
.ie "\\$2"" .I \\$1
.el .IR \\$1 \\$2
.hy
..
.\" Hyphenation exceptions
.hw sarray carray lincom linterp
.\" gd_encoding.3. The gd_encoding man page.
.\"
.\" Copyright (C) 2008, 2009, 2010, 2012, 2016 D. V. Wiebe
.\"
.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.\"
.\" This file is part of the GetData project.
.\"
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.2 or
.\" any later version published by the Free Software Foundation; with no
.\" Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
.\" Texts. A copy of the license is included in the `COPYING.DOC' file
.\" as part of this distribution.
.\"
.TH gd_encoding 3 "25 December 2016" "Version 0.10.0" "GETDATA"
.SH NAME
gd_encoding \(em report the binary encoding of data in a Dirfile
.SH SYNOPSIS
.SC
.B #include <getdata.h>
.HP
.BI "unsigned long gd_encoding(DIRFILE *" dirfile ", int " fragment_index );
.EC
.SH DESCRIPTION
The
.FN gd_encoding
function queries a dirfile(5) database specified by
.ARG dirfile
and returns the data encoding for the fragment indexed by
.ARG fragment_index .
The data encoding of a fragment indicate the encoding of data files associated
with
.B RAW
fields defined in the specified fragment. The encoding of a fragment
containing no
.B RAW
fields is ignored.
.SH RETURN VALUE
Upon successful completion,
.FN gd_encoding
returns the binary encoding of the specified fragment, which will one of the
following symbols:
.IP
.SC
.BR GD_UNENCODED ,
.BR GD_BZIP2_ENCODED ,
.BR GD_FLAC_ENCODED ,
.BR GD_GZIP_ENCODED ,
.BR GD_LZMA_ENCODED ,
.BR GD_SIE_ENCODED ,
.BR GD_SLIM_ENCODED ,
.BR GD_TEXT_ENCODED ,
.BR GD_ZZIP_ENCODED ,
.BR GD_ZZSLIM_ENCODED ,
.BR GD_ENC_UNSUPPORTED .
.EC
.PP
If the encoding scheme specified in the dirfile
metadata is unknown to GetData,
.B GD_ENC_UNSUPPORTED
will be returned. See
.F3 gd_open
and dirfile-encoding(5) for the meanings of the other symbols and details on the
supported encoding schemes.
On error, this function returns zero and stores a negative-valued error code in
the
.B DIRFILE
object which may be retrieved by a subsequent call to
.F3 gd_error .
Possible error codes are:
.DD GD_E_BAD_DIRFILE
The supplied dirfile was invalid.
.DD GD_E_BAD_INDEX
The supplied index was out of range.
.PP
A descriptive error string for the error may be obtained by calling
.F3 gd_error_string .
.SH HISTORY
The
.FN get_encoding
function appeared in GetData-0.5.0.
In GetData-0.7.0, this function was renamed to
.FN gd_encoding .
.SH SEE ALSO
.F3 gd_alter_encoding ,
.F3 gd_error ,
.F3 gd_error_string ,
.F3 gd_getdata ,
.F3 gd_open ,
dirfile(5), dirfile-encoding(5)
|
