php-doc-en/internals/zendapi/macros/ZEND_MOD_REQUIRED.xml
Hartmut Holzgraefe 09f638433b finished ZEND_MOD_REQUIRED*.xml, can be used as examples for the other
ZEND_MOD_* macros


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@205706 c90b9560-bf6c-de11-be94-00142212c4b1
2006-01-22 14:57:49 +00:00

82 lines
2.2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry id="zend-macro.zend-mod-required">
<refnamediv>
<refname>ZEND_MOD_REQUIRED</refname>
<refpurpose>Create a simple dependency entry for a required extension</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<literallayout>#include &lt;zend_modules.h&gt;</literallayout>
<methodsynopsis>
<void/><methodname>ZEND_MOD_REQUIRED</methodname>
<methodparam><type>char *</type><parameter>ext_name</parameter></methodparam>
</methodsynopsis>
<para>
<function>ZEND_MOD_REQUIRED</function> generates a <type>zend_module_dep</type>
entry for the extension named by <parameter>ext_name</parameter>. A simple entry
without further version specifications is generated.
See <function>ZEND_MOD_REQUIRED_EX</function> for an extended version of this
macro that also allows to specify version dependencies.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>ext_name</parameter></term>
<listitem>
<para>
The name of a reqiured extension
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Code to register the required extension dependency
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See <function>ZEND_MOD_REQUIRED_EX</function> if you also need to
specify extension version requirements.
</para>
<para>
See also <function>ZEND_MOD_OPTIONAL</function>,
<function>ZEND_MOD_OPTIONAL_EX</function>,
<function>ZEND_MOD_CONFLICTS</function>, and
<function>ZEND_MOD_CONFLICTS_EX</function>.
</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
-->