File: posix-mknod.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (132 lines) | stat: -rw-r--r-- 3,468 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.posix-mknod" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>posix_mknod</refname>
  <refpurpose>
   Create a special or ordinary file (POSIX.1)
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>posix_mknod</methodname>
   <methodparam><type>string</type><parameter>pathname</parameter></methodparam>
   <methodparam><type>int</type><parameter>mode</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>major</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>minor</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Creates a special or ordinary file.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>pathname</parameter></term>
     <listitem>
      <para>
       The file to create
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       This parameter is constructed by a bitwise OR between file type (one of
       the following constants: <constant>POSIX_S_IFREG</constant>,
       <constant>POSIX_S_IFCHR</constant>, <constant>POSIX_S_IFBLK</constant>,
       <constant>POSIX_S_IFIFO</constant> or
       <constant>POSIX_S_IFSOCK</constant>) and permissions.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>major</parameter></term>
     <listitem>
      <para>
       The major device kernel identifier (required to pass when using
       <constant>S_IFCHR</constant> or <constant>S_IFBLK</constant>).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>minor</parameter></term>
     <listitem>
      <para>
       The minor device kernel identifier.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>posix_mknod</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

$file = '/tmp/tmpfile';  // file name
$type = POSIX_S_IFBLK;   // file type
$permissions = 0777;     // octal
$major = 1;
$minor = 8;              // /dev/random

if (!posix_mknod($file, $type | $permissions, $major, $minor)) {
    die('Error ' . posix_get_last_error() . ': ' . posix_strerror(posix_get_last_error()));
}

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>posix_mkfifo</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:"~/.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
-->