1<!--$Id: memp_set_ftype.so,v 10.17 2005/11/30 19:46:21 bostic Exp $-->
2<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
3<!--See the file LICENSE for redistribution information.-->
4<html>
5<head>
6<title>Berkeley DB: DbMpoolFile::set_ftype</title>
7<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
8<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
9</head>
10<body bgcolor=white>
11<table width="100%"><tr valign=top>
12<td>
13<b>DbMpoolFile::set_ftype</b>
14</td>
15<td align=right>
16<a href="/api_cxx/api_core.html"><img src="/images/api.gif" alt="API"></a>
17<a href="/ref/toc.html"><img src="/images/ref.gif" alt="Ref"></a></td>
18</tr></table>
19<hr size=1 noshade>
20<tt>
21<b><pre>
22#include &lt;db_cxx.h&gt;
23<p>
24int
25DbMpoolFile::set(int ftype);
26<p>
27int
28DbMpoolFile::get_ftype(int *ftypep);
29</pre></b>
30<hr size=1 noshade>
31<b>Description: DbMpoolFile::set_ftype</b>
32<p>The DbMpoolFile::set_ftype method specifies a file type for the purposes of
33input or output processing of the file's pages as they are read from or
34written to, the backing filesystem store.</p>
35<p>The DbMpoolFile::set_ftype method configures a file in the memory pool, not only
36operations performed using the specified <a href="/api_cxx/mempfile_class.html">DbMpoolFile</a> handle.</p>
37<p>The DbMpoolFile::set_ftype method may not be called after the <a href="/api_cxx/memp_fopen.html">DbMpoolFile::open</a> method is
38called.
39If the file is already open in the memory pool when
40<a href="/api_cxx/memp_fopen.html">DbMpoolFile::open</a> is called, the information specified to DbMpoolFile::set_ftype
41will replace the existing information.</p>
42<p>The DbMpoolFile::set_ftype method
43either returns a non-zero error value
44or throws an exception that encapsulates a non-zero error value on
45failure, and returns 0 on success.
46</p>
47<b>Parameters</b> <br>
48 <b>ftype</b><ul compact><li>The <b>ftype</b> parameter sets the file's type for the purposes of input
49and output processing.  The <b>ftype</b> must be the same as a
50<b>ftype</b> parameter previously specified to the <a href="/api_cxx/memp_register.html">DbEnv::memp_register</a> method.
51(See the <a href="/api_cxx/memp_register.html">DbEnv::memp_register</a> documentation for more information.)</ul>
52<br>
53<hr size=1 noshade>
54<b>Description: DbMpoolFile::get_ftype</b>
55<p>The DbMpoolFile::get_ftype method returns the file type.</p>
56<p>The DbMpoolFile::get_ftype method may be called at any time during the life of the
57application.</p>
58<p>The DbMpoolFile::get_ftype method
59either returns a non-zero error value
60or throws an exception that encapsulates a non-zero error value on
61failure, and returns 0 on success.
62</p>
63<b>Parameters</b> <br>
64 <b>ftypep</b><ul compact><li>The DbMpoolFile::get_ftype method returns  the
65file type in <b>ftypep</b>.</ul>
66<br>
67<hr size=1 noshade>
68<br><b>Class</b>
69<a href="/api_cxx/env_class.html">DbEnv</a>, <a href="/api_cxx/mempfile_class.html">DbMpoolFile</a>
70<br><b>See Also</b>
71<a href="/api_cxx/memp_list.html">Memory Pools and Related Methods</a>
72</tt>
73<table width="100%"><tr><td><br></td><td align=right>
74<a href="/api_cxx/api_core.html"><img src="/images/api.gif" alt="API"></a><a href="/ref/toc.html"><img src="/images/ref.gif" alt="Ref"></a>
75</td></tr></table>
76<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
77</body>
78</html>
79