mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-30 15:58:55 +00:00
f19a0e6cd2
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@208999 c90b9560-bf6c-de11-be94-00142212c4b1
96 lines
2.7 KiB
XML
96 lines
2.7 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.1 $ -->
|
|
<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. -->
|
|
<refentry id="function.finfo-open">
|
|
<refnamediv>
|
|
<refname>finfo_open</refname>
|
|
<refpurpose>Create a new fileinfo resource</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>finfo_open</methodname>
|
|
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>arg</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<classsynopsis>
|
|
<ooclass><classname>finfo</classname></ooclass>
|
|
<constructorsynopsis>
|
|
<methodname>__construct</methodname>
|
|
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>magic_file</parameter></methodparam>
|
|
</constructorsynopsis>
|
|
</classsynopsis>
|
|
|
|
<para>
|
|
This function opens a magic database and returns its resource.
|
|
</para>
|
|
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>options</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
One or disjunction of more <link linkend="fileinfo.constants">Fileinfo
|
|
constants</link>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>magic_file</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Name of a magic database file, usually something like
|
|
<filename>/path/to/magic.mime</filename>. If not specified,
|
|
<literal>MAGIC</literal> environment variable is used. If this variable
|
|
is not set neither, <filename>/usr/share/misc/magic</filename> is used.
|
|
<literal>.mime</literal> and/or <literal>.mgc</literal> is added if
|
|
appropriate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns a magic database resource on success or &false; on failure.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>finfo_close</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
|
|
-->
|