php-doc-en/reference/dbm/functions/dbmopen.xml
Mehdi Achour 2c966125ab dbm: switch to new docstyle
# And encourage people to use PDO instead of DBA as a replacement ;)


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@227187 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-14 03:48:41 +00:00

103 lines
3.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry id="function.dbmopen">
<refnamediv>
<refname>dbmopen</refname>
<refpurpose>Opens a DBM database</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>dbmopen</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>string</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Opens the specified DBM database in the given mode.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
The full-path filename of the DBM file to be opened
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
The file open mode which is one of <literal>r</literal>,
<literal>n</literal>, <literal>c</literal> or <literal>w</literal>,
for read-only, new (implies read-write, and most likely will truncate
an already-existing database of the same name), create (implies
read-write, and will not truncate an already-existing database of the
same name) and read-write respectively.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an identifier to be passed to the other DBM functions on
success, or &false; on failure.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
If NDBM support is used, NDBM will actually create
<filename>filename.dir</filename> and <filename>filename.pag</filename>
files. GDBM only uses one file, as does the internal flat-file support,
and Berkeley DB creates a <filename>filename.db</filename> file.
</para>
<para>
Note that PHP does its own file locking in addition to any file locking
that may be done by the DBM library itself. PHP does not delete the
<filename>.lck</filename> files it creates. It uses these files simply as
fixed inodes on which to do the file locking. For more information on DBM
files, see your Unix man pages, or obtain
<ulink url="&url.gdbm;">GNU's GDBM</ulink>.
</para>
</note>
&note.sm.uidcheck;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>dbmclose</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->