annotate scripts/@ftp/rename.m @ 11100:cdf940db26a0

provide mxIsFunctionHandle MEX interface function
author John W. Eaton <jwe@octave.org>
date Sat, 16 Oct 2010 13:27:18 -0400
parents fbd7843974fa
children 2c356a35d7f5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9880
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
1 ## Copyright (C) 2009 David Bateman
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
2 ##
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
3 ## This program is free software; you can redistribute it and/or modify
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
4 ## it under the terms of the GNU General Public License as published by
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
5 ## the Free Software Foundation; either version 2 of the License, or
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
6 ## (at your option) any later version.
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ##
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ## This program is distributed in the hope that it will be useful,
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
11 ## GNU General Public License for more details.
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
12 ##
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
13 ## You should have received a copy of the GNU General Public License
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ## along with this program; If not, see <http://www.gnu.org/licenses/>.
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
15
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
16 ## -*- texinfo -*-
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
17 ## @deftypefn {Function File} {} rename (@var{f}, @var{oldname}, @var{newname})
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
18 ## Rename or move the remote file or directory @var{oldname} to @var{newname},
10711
fbd7843974fa Periodic grammar check of documentation files to ensure common format.
Rik <octave@nomad.inbox5.com>
parents: 9880
diff changeset
19 ## over the FTP connection @var{f}. @var{f} is an FTP object returned by the
9880
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
20 ## ftp function.
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
21 ## @end deftypefn
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
22
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
23 function rename (obj, oldname, newname)
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
24 __ftp_rename__ (obj.curlhandle, oldname, newname);
7f77e5081e83 Add ftp objects
David Bateman <dbateman@free.fr>
parents:
diff changeset
25 endfunction