php-doc-en/reference/nsapi/functions/nsapi-virtual.xml
Jakub Vrana a9b26c34e4 Display language constructs without parentheses
Side effect of this change is that include, require and return are now properly linked. They weren't because they don't live inside <refentry> so PhD doesn't know about them.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@324522 c90b9560-bf6c-de11-be94-00142212c4b1
2012-03-25 08:39:30 +00:00

88 lines
2.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.nsapi-virtual" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>nsapi_virtual</refname>
<refpurpose>Perform an NSAPI sub-request</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>nsapi_virtual</methodname>
<methodparam><type>string</type><parameter>uri</parameter></methodparam>
</methodsynopsis>
<para>
<function>nsapi_virtual</function> is an NSAPI-specific function which
is equivalent to <literal>&lt;!--#include virtual...--&gt;</literal>
in <acronym>SSI</acronym>
(<filename>.shtml</filename> files). It does an NSAPI sub-request.
It is useful for including CGI scripts or .shtml files, or anything
else that you'd parse through webserver.
</para>
<para>
To run the sub-request, all buffers are terminated and flushed to the
browser, pending headers are sent too.
</para>
<para>
You cannot make recursive requests with this function to other PHP scripts.
If you want to include PHP scripts, use <link linkend="function.include"><literal>include</literal></link> or
<link linkend="function.require"><literal>require</literal></link>.
</para>
<note>
<para>
This function depends on a undocumented feature of the Netscape/iPlanet/Sun
webservers. Use <function>phpinfo</function> to determine if it is available.
In the Unix environment it should always work, in Windows it depends on the name of
a <filename>ns-httpdXX.dll</filename> file.
</para>
<para>
Read the note about subrequests in the NSAPI section (<link
linkend="install.unix.sun.notes">UNIX</link>, <link
linkend="install.windows.sun.notes">Windows</link>) if you experience
this problem.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>uri</parameter></term>
<listitem>
<para>
The URI of the script.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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:"~/.phpdoc/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
-->