Specify if a connection to the server is secure.

Syntax

object.Secure [= { True | False } ]

Remarks

The Secure property determines if a secure connection is established to the server. The default value for this property is False, which specifies that a standard connection to the server is used. To establish a secure connection, the application must set this property value to True prior to calling the Connect method. Once the connection has been established, the client may retrieve messages from the server as with standard connections.

It is strongly recommended that any application that sets this property to True use error handling to trap any errors that may occur. If the control is unable to initialize the security libraries, or otherwise cannot create a secure session for the client, an error will be generated when this property value is set.

If you are connecting to an FTP server, you should check to see if the server requires the use of the AUTH command to establish an explicit, secure session. If so, you must set the Options property to fileOptionSecureExplicit prior to calling the Connect method.

Data Type

Boolean

Example

The following example establishes a secure connection to a server and retrieves a file:

FileTransfer1.ServerType = fileServerHttp
FileTransfer1.ServerName = strHostName
FileTransfer1.ServerPort = 443
FileTransfer1.Secure = True

nError = FileTransfer1.Connect()
If nError > 0 Then
    MsgBox "Unable to connect to server " & strHostName, vbExclamation
    Exit Sub
End If

If FileTransfer1.CertificateStatus <> stCertificateValid Then
    lResult = MsgBox("The server certificate could not be validated" & vbCrLf & _
                      "Are you sure you wish to continue?", vbYesNo)

    If lResult = vbNo Then
        FileTransfer1.Disconnect
        Exit Sub
    End If
End If

nError = FileTransfer1.GetFile(strLocalFile, strRemoteFile)
FileTransfer1.Disconnect

If nError > 0 Then
    MsgBox "Unable to retrieve file from server " & strHostName
    Exit Sub
End If

See Also

URL Property, Connect Method

Copyright © 2025 Catalyst Development Corporation. All rights reserved.