File: db_env_set_func_ioinfo.html

package info (click to toggle)
db5.3 5.3.28-9%2Bdeb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 163,332 kB
  • sloc: ansic: 448,411; java: 111,824; tcl: 80,544; sh: 44,326; cs: 33,697; cpp: 21,604; perl: 14,557; xml: 10,799; makefile: 4,104; yacc: 1,003; awk: 965; sql: 801; erlang: 342; python: 216; php: 24; asm: 14
file content (145 lines) | stat: -rw-r--r-- 6,759 bytes parent folder | download | duplicates (8)
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
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>db_env_set_func_ioinfo</title>
    <link rel="stylesheet" href="apiReference.css" type="text/css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
    <link rel="start" href="index.html" title="Berkeley DB C API Reference" />
    <link rel="up" href="setfunc.html" title="Appendix C.  Berkeley DB Application Space Static Functions" />
    <link rel="prev" href="db_env_set_func_ftruncate.html" title="db_env_set_func_ftruncate" />
    <link rel="next" href="db_env_set_func_malloc.html" title="db_env_set_func_malloc" />
  </head>
  <body>
    <div xmlns="" class="navheader">
      <div class="libver">
        <p>Library Version 11.2.5.3</p>
      </div>
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">db_env_set_func_ioinfo</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="db_env_set_func_ftruncate.html">Prev</a> </td>
          <th width="60%" align="center">Appendix C. 
                Berkeley DB Application Space Static Functions
        </th>
          <td width="20%" align="right"> <a accesskey="n" href="db_env_set_func_malloc.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="sect1" lang="en" xml:lang="en">
      <div class="titlepage">
        <div>
          <div>
            <h2 class="title" style="clear: both"><a id="db_env_set_func_ioinfo"></a>db_env_set_func_ioinfo</h2>
          </div>
        </div>
      </div>
      <pre class="programlisting">#include &lt;db.h&gt;

int
db_env_set_func_ioinfo(int (*func_ioinfo)(const char *path,
    int fd, u_int32_t *mbytesp, u_int32_t *bytesp, u_int32_t *iosizep)); </pre>
      <p>
         The Berkeley DB library requires the ability to determine the size and
         I/O characteristics of a file.
    </p>
      <p>
         The <code class="function">db_env_set_func_ioinfo()</code> function configures all operations performed
         by a process and all of its threads of control, not operations
         confined to a single database environment.
    </p>
      <p>
         Although the <code class="function">db_env_set_func_ioinfo()</code> function may be called at any time
         during the life of the application, it should normally be called
         before making calls to the <a class="xref" href="envcreate.html" title="db_env_create">db_env_create</a> or
         <a class="xref" href="dbcreate.html" title="db_create">db_create</a> methods.
    </p>
      <p>
         The <code class="function">db_env_set_func_ioinfo()</code> <span>
                  function returns a non-zero error value on failure and 0 on success.
            </span>
    </p>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idp55638192"></a>Parameters</h3>
            </div>
          </div>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idp55638384"></a>func_ioinfo</h4>
              </div>
            </div>
          </div>
          <p>
                          The <span class="bold"><strong>func_ioinfo</strong></span> parameter is the
                          function which returns the size and I/O characteristics of a file.    
                      </p>
          <p>
                          The <span class="bold"><strong>path</strong></span> parameter is the pathname of
                          the file to be checked, and the <span class="bold"><strong>fd</strong></span>
                          parameter is an open file descriptor on the file.
                     </p>
          <p>
                          If the <span class="bold"><strong>mbytesp</strong></span> and <span class="bold"><strong>bytesp</strong></span> parameters are non-NULL, the <span class="bold"><strong>ioinfo</strong></span> function must return in them the size of
                          the file: the number of megabytes in the file into the memory location
                          to which the <span class="bold"><strong>mbytesp</strong></span> parameter
                          refers, and the number of bytes over and above that number of
                          megabytes into the memory location to which the <span class="bold"><strong>bytesp</strong></span> parameter refers.
                     </p>
          <p>
                          In addition, if the <span class="bold"><strong>iosizep</strong></span> parameter
                          is non-NULL, the <span class="bold"><strong>ioinfo</strong></span> function must
                          return the optimum granularity for I/O operations to the file into the
                          memory location to which it refers.
                     </p>
          <p>
                          The <span class="bold"><strong>func_ioinfo</strong></span> function must return
                          the value of <span class="bold"><strong>errno</strong></span> on failure and 0
                          on success.
                     </p>
        </div>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idp55632920"></a>See Also</h3>
            </div>
          </div>
        </div>
        <p>
          <a href="../../programmer_reference/program_runtime.html" class="olink">Run-time configuration</a>

     </p>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="db_env_set_func_ftruncate.html">Prev</a> </td>
          <td width="20%" align="center">
            <a accesskey="u" href="setfunc.html">Up</a>
          </td>
          <td width="40%" align="right"> <a accesskey="n" href="db_env_set_func_malloc.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">db_env_set_func_ftruncate </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> db_env_set_func_malloc</td>
        </tr>
      </table>
    </div>
  </body>
</html>