ICIConnectedUser Interface

The ICIConnectedUser interface is used to retrieve information about connected users. See also the ICISite::ConnectedUsers property.

interface ICIConnectedUser : IDispatch

Members

• Property ConnectedAt As Date read-only

Retrieves the date/time the user connected.

HRESULT ConnectedAt([out,retval] DATE* pVal);

Example (VBScript):

MsgBox "Connected at: " & oCU.ConnectedAt

EFT v6.3 and later

• Property ConnectionType As String read-only

Retrieves the type of connection (e.g., FTP, HTTP, HTTPS, SFTP).

HRESULT ConnectionType([out,retval] BSTR* pVal);

Example (VBScript):

MsgBox "Connection type: " & oCU.ConnectionType

EFT v6.3 and later

• Property DataConnection As String read-only

Retrieves the data connection state ("No data connection.", "RETRieving file", "STORing file", "RETRieving folder listing", and "N/A").

HRESULT DataConnection([out,retval] BSTR* pVal);

Example (VBScript):

MsgBox "Data connection state: " & oCU.DataConnection

EFT v6.3 and later

• Property FileName As String read-only

Retrieves the filename currently downloading/uploading.

HRESULT FileName([out,retval] BSTR* pVal);

Example (VBScript):

MsgBox "File name:" & CStr(oCU.FileName)

EFT v6.3 and later

• Property FileSize As Signed Double Long read-only

Retrieves the file size of the file currently downloading.

HRESULT FileSize([out,retval] LONGLONG* pVal);

Example (VBScript):

MsgBox "File size: " & CStr(oCU.FileSize)

EFT v6.3 and later

• Property ID As Long read-only

Retrieves the connection ID.

HRESULT ID([out, retval] LONG* pVal);

Example (VBScript):

MsgBox "ID: " & oCU.ID

EFT v6.3 and later

• Property IP As String read-only

Retrieves the user's connecting IP address.

HRESULT IP([out,retval] BSTR* pVal);

Example (VBScript):

Retrieving:

MsgBox "IP: " & oCU.IP

EFT v6.3 and later

• Property Log As String

Retrieves the name of the transfer log.

HRESULT Log([out,retval] BSTR* pVal);

Example (VBScript):

MsgBox "Log: " & oCU.Log

EFT v6.3 and later

• Property Login As String read-only

Retrieves the username.

HRESULT Login([out, retval] BSTR* pVal);

Example (VBScript):

MsgBox "User: " & oCU.Login

EFT v6.3 and later

• Property Structure As String read-only

Retrieves data connection structure (“File” or “N/A”).

HRESULT Structure([out,retval] BSTR* pVal);

Example (VBScript):

MsgBox "Structure: " & oCU.Structure

EFT v6.3 and later

• Property TransferMode As String read-only

Retrieves the transfer mode. (Possible values are "stream" or "N/A")

HRESULT TransferMode([out,retval] BSTR* pVal);

Example (VBScript):

MsgBox "Structure: " & oCU.Structure

EFT v6.3 and later

• Property TransferredSize As Signed Double Long read-only

Retrieves the transferred size in bytes.

HRESULT TransferredSize([out,retval] LONGLONG* pVal);

Example (VBScript):

MsgBox "Transferred size: " & CStr(oCU.TransferredSize)

EFT v6.3 and later

• Property TransferTime As Long read-only

Retrieves the transfer time in seconds.

HRESULT TransferTime([out,retval] LONG* pVal);

Example (VBScript):

MsgBox "Transfer time: " & CStr(oCU.TransferTime)

EFT v6.3 and later

• Property type As String read-only

Retrieves the mode of connection ("ASCII”, "IMAGE”, "EBCDIC"). Only for FTP, FTPS explicit, FTPS implicit connections; for others it returns "N/A."

HRESULT Type([out,retval] BSTR* pVal);

Example (VBScript):

MsgBox "Type: " & oCU.Type

EFT v6.3 and later

Dialog Box Equivalents

The ICIConnectedUser interface members correlate to the following fields and controls in the EFT administration interface. (EFT Enterprise v6.3 is shown in illustration; the properties are the same in later versions.)