[wxWidgets.git] / docs / latex / wx / ftp.tex

\section{\class{wxFTP}}\label{wxftp}

\wxheading{Derived from}

\helpref{wxProtocol}{wxprotocol}

\wxheading{Include files}

<wx/ftp.h>

\wxheading{See also}

\helpref{wxSocketBase}{wxsocketbase}

% ----------------------------------------------------------------------------
% Members
% ----------------------------------------------------------------------------

\latexignore{\rtfignore{\membersection{Members}}}

\membersection{wxFTP::SendCommand}

\func{bool}{SendCommand}{\param{const wxString\&}{ command}, \param{char }{ret}}

Send the specified \it{command} to the FTP server. \it{ret} specifies
the expected result.

\wxheading{Return value}

TRUE, if the command has been sent successfully, else FALSE.

% ----------------------------------------------------------------------------

\membersection{wxFTP::GetLastResult}

\func{const wxString\&}{GetLastResult}{\void}

Returns the last command result.

% ----------------------------------------------------------------------------

\membersection{wxFTP::ChDir}

\func{bool}{ChDir}{\param{const wxString\&}{ dir}}

Change the current FTP working directory.
Returns TRUE, if successful.

\membersection{wxFTP::MkDir}

\func{bool}{MkDir}{\param{const wxString\&}{ dir}}

Create the specified directory in the current FTP working directory.
Returns TRUE, if successful.

\membersection{wxFTP::RmDir}

\func{bool}{RmDir}{\param{const wxString\&}{ dir}}

Remove the specified directory from the current FTP working directory.
Returns TRUE, if successful.

\membersection{wxFTP::Pwd}

\func{wxString}{Pwd}{\void}

Returns the current FTP working directory.

% ----------------------------------------------------------------------------

\membersection{wxFTP::Rename}

\func{bool}{Rename}{\param{const wxString\&}{ src}, \param{const wxString\&}{ dst}}

Rename the specified \it{src} element into \it{dst}
Returns TRUE, if successful.

% ----------------------------------------------------------------------------

\membersection{wxFTP::RmFile}

\func{bool}{RmFile}{\param{const wxString\&}{ path}}

Delete the file specified by \it{path}.
Returns TRUE, if successful.

% ----------------------------------------------------------------------------

\membersection{wxFTP::GetOutputStream}

\func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{ file}}

Initializes an output stream to the specified \it{file}. The returned
stream has all but the seek functionality of wxStreams. When the user finishes
writing data, he has to delete the stream to close it.

\wxheading{Return value}

An initialized write-only stream.

\wxheading{See also}

\helpref{wxOutputStream}{wxoutputstream}
Commit	Line	Data
7d2946d2 GL	1	\section{\class{wxFTP}}\label{wxftp}
	2
	3	\wxheading{Derived from}
	4
	5	\helpref{wxProtocol}{wxprotocol}
	6
954b8ae6 JS	7	\wxheading{Include files}
	8
	9	<wx/ftp.h>
	10
7d2946d2 GL	11	\wxheading{See also}
	12
	13	\helpref{wxSocketBase}{wxsocketbase}
	14
	15	% ----------------------------------------------------------------------------
	16	% Members
	17	% ----------------------------------------------------------------------------
	18
	19	\latexignore{\rtfignore{\membersection{Members}}}
	20
	21	\membersection{wxFTP::SendCommand}
	22
6be663cf	23	\func{bool}{SendCommand}{\param{const wxString\&}{ command}, \param{char }{ret}}
7d2946d2 GL	24
	25	Send the specified \it{command} to the FTP server. \it{ret} specifies
	26	the expected result.
	27
	28	\wxheading{Return value}
	29
	30	TRUE, if the command has been sent successfully, else FALSE.
	31
	32	% ----------------------------------------------------------------------------
	33
	34	\membersection{wxFTP::GetLastResult}
	35
	36	\func{const wxString\&}{GetLastResult}{\void}
	37
	38	Returns the last command result.
	39
	40	% ----------------------------------------------------------------------------
	41
	42	\membersection{wxFTP::ChDir}
	43
6be663cf	44	\func{bool}{ChDir}{\param{const wxString\&}{ dir}}
7d2946d2 GL	45
	46	Change the current FTP working directory.
	47	Returns TRUE, if successful.
	48
	49	\membersection{wxFTP::MkDir}
	50
6be663cf	51	\func{bool}{MkDir}{\param{const wxString\&}{ dir}}
7d2946d2 GL	52
	53	Create the specified directory in the current FTP working directory.
	54	Returns TRUE, if successful.
	55
	56	\membersection{wxFTP::RmDir}
	57
6be663cf	58	\func{bool}{RmDir}{\param{const wxString\&}{ dir}}
7d2946d2 GL	59
	60	Remove the specified directory from the current FTP working directory.
	61	Returns TRUE, if successful.
	62
	63	\membersection{wxFTP::Pwd}
	64
	65	\func{wxString}{Pwd}{\void}
	66
	67	Returns the current FTP working directory.
	68
	69	% ----------------------------------------------------------------------------
	70
	71	\membersection{wxFTP::Rename}
	72
6be663cf	73	\func{bool}{Rename}{\param{const wxString\&}{ src}, \param{const wxString\&}{ dst}}
7d2946d2 GL	74
	75	Rename the specified \it{src} element into \it{dst}
	76	Returns TRUE, if successful.
	77
	78	% ----------------------------------------------------------------------------
	79
	80	\membersection{wxFTP::RmFile}
	81
6be663cf	82	\func{bool}{RmFile}{\param{const wxString\&}{ path}}
7d2946d2 GL	83
	84	Delete the file specified by \it{path}.
	85	Returns TRUE, if successful.
	86
	87	% ----------------------------------------------------------------------------
	88
	89	\membersection{wxFTP::GetOutputStream}
	90
6be663cf	91	\func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{ file}}
7d2946d2 GL	92
7d2946d2 GL	93	Initializes an output stream to the specified \it{file}. The returned
6be663cf	94	stream has all but the seek functionality of wxStreams. When the user finishes
7d2946d2 GL	95	writing data, he has to delete the stream to close it.
	96
	97	\wxheading{Return value}
	98
	99	An initialized write-only stream.
6be663cf	100
7f42cff1 GL	101	\wxheading{See also}
	102
	103	\helpref{wxOutputStream}{wxoutputstream}