Status Method

Description

Get server status information.

Syntax

Visual Basic
Public Sub Status( _ ByRef Result As Variant, _ Optional ByVal PathName As String _ )

Parameters

Result: Undimensioned String. Where the reply from the server will be put. Any contents are replaced.
PathName: Optional. Usually specifies a full or partial path name.

Remarks

Sends the ftpStatus command.

This method may have an argument. If the argument is a path name, this method is analogous to the List method except data is transferred (more quickly) over the control connection. If a partial path name is given, the server may respond with a list of file names or attributes associated with that specification. If no argument is given, the server should return general status information about the server FTP process (this should include current values of all transfer parameters and the status of connections).

If Timeout is greater than 0, this method blocks until a reply is received from the server or a ptTimeout error occurs. If Timeout is 0, this method immediately returns and the Progress event fires with FtpCmd = ftpStatus when the reply is received. The Result parameter is used to capture the reply, so it must not go out of scope while the command completes (it must have file or global scope).

Error Codes

This method may generate the following error code (refer to ErrorConstants for a complete list of error codes):

ptBlocked
ptConnectionAborted
ptConnectionReset
ptNetworkDown
ptNetworkReset
ptNoBufferSpace
ptNotConnected
ptTimeout