Site Method

Description

Specify or request site-specific services. The nature of these services and the specification of their syntax can be found in the Result parameter of the Help method.

Syntax

Visual Basic
Public Sub Site( _ ByVal Modifier As String, _ ByRef Result As Variant _ )

Parameters

Modifier: Specifies a modifier.
Result: Undimensioned string. Where the reply from the server will be put. Any contents will be replaced.

Remarks

Sends the ftpSite command.

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 = ftpSite when the reply is received. The Result parameter is used to capture the data 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

Example

Example (VB6)

Private Sub Command1_Click()
	On Error Goto OnError ' use intrinsic error handling
	Dim Result As String ' local scope allowed because Timeout > 0
	Ftp1.Timeout = 1000
	' get help on the SITE command
	Ftp1.Site "Help", Result
	Text1.Text = Result ' show to user
	Exit Sub
OnError: ' Any error jumps here
	Debug.Print "Error #" + CStr(Err.Number) + ": " + Err.Description
End Sub