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

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

\wxheading{Derived from}

\helpref{wxProtocol}{wxprotocol}

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