SmartFTP FTP Library
IGlobal Interface Reference

Provides global configuration, statistics, and licensing management for the library. More...

import "sfFTPLib.idl";

Public Member Functions

HRESULT LoadLicense ([in] BSTR productKey)
 Applies a product key to license the component.

Properties

BSTR Version [get]
 Retrieves the version of the library.
VARIANT_BOOL FIPS [get, set]
 Enables or disables FIPS 140-2 compliant mode.
ULONGLONG TotalBytesReceived [get]
 Retrieves the total number of bytes received by all instances of the library.
ULONGLONG TotalBytesSent [get]
 Retrieves the total number of bytes sent by all instances of the library.
BSTR ActivationUrl [get, set]
 Sets or retrieves the URL used for online activation.

Detailed Description

Provides global configuration, statistics, and licensing management for the library.

This interface acts as the central entry point for library-wide settings that affect all connections. It is typically implemented as a Singleton.

Member Function Documentation

◆ LoadLicense()

HRESULT IGlobal::LoadLicense ( [in] BSTR productKey)

Applies a product key to license the component.

Attempts to activate the library using the provided key.

Usage: Call this method once at the startup of your application, before initializing any sfFTPLib::FTPConnectionMTA or sfFTPLib::SSHConnection objects

Remarks
see the provided samples on how to use it.
Parameters
[in]productKeyThe product key string received upon purchase.
  • Format: A GUID-like string, e.g., 639BC46E-66B6-489B-AB68-3F8DF04547EF.

Property Documentation

◆ ActivationUrl

BSTR IGlobal::ActivationUrl
getsetproperty

Sets or retrieves the URL used for online activation.

By default, the library connects to the official licensing server. Use this property only if you are using a proxy, an internal licensing server, or need to override the endpoint for firewall reasons.

Parameters
[in]newValThe full URL of the activation server.
[out]retvalPointer to a BSTR receiving the current URL.

◆ FIPS

VARIANT_BOOL IGlobal::FIPS
getsetproperty

Enables or disables FIPS 140-2 compliant mode.

When set to TRUE, the library enforces the Federal Information Processing Standards (FIPS) security requirements.

Parameters
[in]newValueBoolean value to enable (TRUE) or disable (FALSE) FIPS mode.
[out]retvalPointer to a VARIANT_BOOL receiving the current state.

◆ TotalBytesReceived

ULONGLONG IGlobal::TotalBytesReceived
getproperty

Retrieves the total number of bytes received by all instances of the library.

This counter aggregates the incoming data traffic (downloads, directory listings, command responses) for the lifetime of the process.

Parameters
[out]retvalPointer to a ULONGLONG (unsigned 64-bit integer) receiving the byte count.

◆ TotalBytesSent

ULONGLONG IGlobal::TotalBytesSent
getproperty

Retrieves the total number of bytes sent by all instances of the library.

This counter aggregates the outgoing data traffic (uploads, commands) for the lifetime of the process.

Parameters
[out]retvalPointer to a ULONGLONG (unsigned 64-bit integer) receiving the byte count.

◆ Version

BSTR IGlobal::Version
getproperty

Retrieves the version of the library.

Returns the version string in the format Major.Minor.Build.Revision (e.g., "1.0.2.15").

Parameters
[out]retvalPointer to a BSTR that receives the version string.
The documentation for this interface was generated from the following file: