Add to git.
[pthrlib.git] / doc / ftpc_ls.3.html
1 <html>
2 <head>
3 <meta name="generator" content="groff -Thtml, see www.gnu.org">
4 <meta name="Content-Style" content="text/css">
5 <title>ftpc_ls</title>
6 </head>
7 <body>
8
9 <h1 align=center>ftpc_ls</h1>
10 <a href="#NAME">NAME</a><br>
11 <a href="#SYNOPSIS">SYNOPSIS</a><br>
12 <a href="#DESCRIPTION">DESCRIPTION</a><br>
13 <a href="#RETURNS">RETURNS</a><br>
14 <a href="#AUTHOR">AUTHOR</a><br>
15 <a href="#LICENSE">LICENSE</a><br>
16 <a href="#VERSION">VERSION</a><br>
17
18 <hr>
19 <!-- Creator     : groff version 1.17.2 -->
20 <!-- CreationDate: Fri Aug 30 16:16:17 2002 -->
21 <a name="NAME"></a>
22 <h2>NAME</h2>
23 <table width="100%" border=0 rules="none" frame="void"
24        cols="2" cellspacing="0" cellpadding="0">
25 <tr valign="top" align="left">
26 <td width="10%"></td><td width="90%">
27 ftpc_ls, ftpc_dir - List the contents of a directory on the server.</td></table>
28 <a name="SYNOPSIS"></a>
29 <h2>SYNOPSIS</h2>
30
31 <table width="100%" border=0 rules="none" frame="void"
32        cols="2" cellspacing="0" cellpadding="0">
33 <tr valign="top" align="left">
34 <td width="10%"></td><td width="90%">
35 <pre><b>#include &lt;pthr_ftpc.h&gt;
36
37 vector ftpc_ls (ftpc ftpc, pool, const char *pathname);
38 vector ftpc_dir (ftpc ftpc, pool, const char *pathname);
39 </b></pre></td></table>
40 <a name="DESCRIPTION"></a>
41 <h2>DESCRIPTION</h2>
42
43 <table width="100%" border=0 rules="none" frame="void"
44        cols="2" cellspacing="0" cellpadding="0">
45 <tr valign="top" align="left">
46 <td width="10%"></td><td width="90%">
47 <b>ftpc_ls</b> and <b>ftpc_dir</b> list the contents of
48 either the current directory (if <b>pathname</b> is
49 <b>NULL</b>) or else another directory
50 <b>pathname</b>.</td></table>
51
52 <table width="100%" border=0 rules="none" frame="void"
53        cols="2" cellspacing="0" cellpadding="0">
54 <tr valign="top" align="left">
55 <td width="10%"></td><td width="90%">
56 <b>ftpc_ls</b> issues the command <b>NLST -a</b>, returning
57 a vector of strings giving the name of each
58 file.</td></table>
59
60 <table width="100%" border=0 rules="none" frame="void"
61        cols="2" cellspacing="0" cellpadding="0">
62 <tr valign="top" align="left">
63 <td width="10%"></td><td width="90%">
64 <b>ftpc_dir</b> issues the command <b>LIST -a</b>, returning
65 a human-readable list of filenames, similar to issuing the
66 <b>ls -al</b> command in Unix.</td></table>
67 <a name="RETURNS"></a>
68 <h2>RETURNS</h2>
69
70 <table width="100%" border=0 rules="none" frame="void"
71        cols="2" cellspacing="0" cellpadding="0">
72 <tr valign="top" align="left">
73 <td width="10%"></td><td width="90%">
74 0 if successful, -1 if the attempt failed. If a fatal error
75 occurs with the connection, an exception is
76 thrown.</td></table>
77 <a name="AUTHOR"></a>
78 <h2>AUTHOR</h2>
79
80 <table width="100%" border=0 rules="none" frame="void"
81        cols="2" cellspacing="0" cellpadding="0">
82 <tr valign="top" align="left">
83 <td width="10%"></td><td width="90%">
84 Richard Jones &lt;rich@annexia.org&gt;</td></table>
85 <a name="LICENSE"></a>
86 <h2>LICENSE</h2>
87
88 <table width="100%" border=0 rules="none" frame="void"
89        cols="2" cellspacing="0" cellpadding="0">
90 <tr valign="top" align="left">
91 <td width="10%"></td><td width="90%">
92 GNU LGPL (see http://www.gnu.org/)</td></table>
93 <a name="VERSION"></a>
94 <h2>VERSION</h2>
95
96 <table width="100%" border=0 rules="none" frame="void"
97        cols="2" cellspacing="0" cellpadding="0">
98 <tr valign="top" align="left">
99 <td width="10%"></td><td width="90%">
100 pthrlib-3.0.3</td></table>
101 <hr>
102 </body>
103 </html>