SmartFTP FTP Library
IProxySettings Interface Reference

IProxySettings Interface. More...

import "sfFTPLib.idl";

Properties

BSTR Host [get, set]
 Gets or sets the proxy host address.
long Port [get, set]
 Gets or sets the proxy server port.
ProxyType Type [get, set]
 Gets or sets the proxy protocol type.
VARIANT_BOOL Authentication [get, set]
 Gets or sets whether proxy authentication is enabled.
BSTR Username [get, set]
 Gets or sets the username for proxy authentication.
BSTR Password [get, set]
 Gets or sets the password for proxy authentication.
long ProtocolFamily [get, set]
 Gets or sets the allowed protocol family.
long ProtocolFamilyPreference [get, set]
 Gets or sets the protocol family preference.

Detailed Description

IProxySettings Interface.

This interface provides methods to configure proxy server settings, including the host, port, authentication credentials, and the type of proxy protocol to use.

Property Documentation

◆ Authentication

VARIANT_BOOL IProxySettings::Authentication
getsetproperty

Gets or sets whether proxy authentication is enabled.

Set to VARIANT_TRUE to enable authentication using the provided Username and Password.

◆ Host

BSTR IProxySettings::Host
getsetproperty

Gets or sets the proxy host address.

The hostname (e.g., "proxy.example.com") or IP address of the proxy server.

◆ Password

BSTR IProxySettings::Password
getsetproperty

Gets or sets the password for proxy authentication.

This property is only used if the Authentication property is set to VARIANT_TRUE.

◆ Port

long IProxySettings::Port
getsetproperty

Gets or sets the proxy server port.

The port number to connect to (e.g., 8080, 1080).

◆ ProtocolFamily

long IProxySettings::ProtocolFamily
getsetproperty

Gets or sets the allowed protocol family.

Configures the address family used for the connection (e.g., AF_INET for IPv4 or AF_INET6 for IPv6).

◆ ProtocolFamilyPreference

long IProxySettings::ProtocolFamilyPreference
getsetproperty

Gets or sets the protocol family preference.

Used to determine which protocol to prioritize (e.g., prefer IPv6 over IPv4) when multiple options are available.

◆ Type

ProxyType IProxySettings::Type
getsetproperty

Gets or sets the proxy protocol type.

Determines which protocol is used (e.g., HTTP, SOCKS4, SOCKS5).

See also
ProxyType

◆ Username

BSTR IProxySettings::Username
getsetproperty

Gets or sets the username for proxy authentication.

This property is only used if the Authentication property is set to VARIANT_TRUE.

The documentation for this interface was generated from the following file: