example uses of new role= attribute for functions

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@205337 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hartmut Holzgraefe 2006-01-15 14:02:22 +00:00
parent 65efdc6fae
commit f9883496c2

View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="zend-api.virtual-access">
<refnamediv>
<refname>virtual_access</refname>
<refpurpose>...</refpurpose>
<refpurpose>Check users permissions for a file</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -16,7 +16,11 @@
<methodparam><type>magic</type><parameter>TSRMLS_DC</parameter></methodparam>
</methodsynopsis>
<para>
...
A thread safe wrapper around the <function role='libc'>access</function> function
that takes per-thread virtual working directories into account.
</para>
<para>
See also <function role="zend-macro">VCWD_ACCESS</function>.
</para>
</refsect1>
@ -28,7 +32,7 @@
<term><parameter>pathname</parameter></term>
<listitem>
<para>
...
File to check permissions for
</para>
</listitem>
</varlistentry>
@ -36,7 +40,7 @@
<term><parameter>mode</parameter></term>
<listitem>
<para>
...
Mode mask
</para>
</listitem>
</varlistentry>
@ -44,7 +48,7 @@
<term><parameter>TSRMLS_DC</parameter></term>
<listitem>
<para>
...
Thread context
</para>
</listitem>
</varlistentry>
@ -55,7 +59,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
...
Returns 0 on success and -1 on errors.
</para>
</refsect1>