File: ssh2-sftp-mkdir.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (74 lines) | stat: -rw-r--r-- 2,300 bytes parent folder | download
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
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
  <refentry id="function.ssh2-sftp-mkdir">
   <refnamediv>
    <refname>ssh2_sftp_mkdir</refname>
    <refpurpose>
     Create a directory     
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <methodsynopsis>
     <type>bool</type><methodname>ssh2_sftp_mkdir</methodname>
     <methodparam><type>resource</type><parameter>sftp</parameter></methodparam>
     <methodparam><type>string</type><parameter>dirname</parameter></methodparam>
     <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
     <methodparam choice="opt"><type>bool</type><parameter>recursive</parameter></methodparam>
    </methodsynopsis>

    <simpara>
     Creates a directory on the remote file server with permissions set to
     <parameter>mode</parameter>.  If <parameter>recursive</parameter> is &true;
     any parent directories required for <parameter>dirname</parameter> will
     be automatically created as well.  
     This function is similar to using <function>mkdir</function> with the
     <link linkend="wrappers.ssh2">ssh2.sftp://</link> wrapper.
    </simpara>

    <example>
     <title>Creating a directory on a remote server</title>
     <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connet('shell.example.com', 22);
ssh2_auth_password($connection, 'username', 'password');
$sftp = ssh2_sftp($connection);

ssh2_sftp_mkdir($sftp, '/home/username/newdir');
/* Or:  mkdir("ssh2.sftp://$sftp/home/username/newdir"); */
?>
]]>
     </programlisting>
    </example>

    <simpara>
     See Also:
     <function>mkdir</function>, and
     <function>ssh2_sftp_rmdir</function>
    </simpara>

   </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
-->