SmartFTP FTP Library
IFTPClientId Interface Reference

Encapsulates the client application identity sent to the server via the CSID and CLNT commands. More...

import "sfFTPLib.idl";

Properties

BSTR Name [get, set]
 Gets or sets the application name used in the CSID and CLNT commands.
BSTR Version [get, set]
 Gets or sets the application version used in the CSID and CLNT commands.

Detailed Description

Encapsulates the client application identity sent to the server via the CSID and CLNT commands.

Property Documentation

◆ Name

BSTR IFTPClientId::Name
getsetproperty

Gets or sets the application name used in the CSID and CLNT commands.

This string identifies your software to the FTP server.

  • Format: Should be a simple alphanumeric string (e.g., "MyBackupApp", "SmartFTP").
  • Usage:
  • CSID: Sent as CSID Name=MyBackupApp;
  • CLNT: Sent as CLNT MyBackupApp
  • Parameters
    [in]newValueThe application name.
    [out]retvalThe current application name.

◆ Version

BSTR IFTPClientId::Version
getsetproperty

Gets or sets the application version used in the CSID and CLNT commands.

This string identifies the specific build or release of your software.

  • Format: Typically a dot-separated string (e.g., "1.0.4", "2023.1").
  • Usage:
  • CSID: Sent as part of the key-value pair set (e.g., ... Version=1.0.4;).
  • CLNT: Often appended to the name or sent in a secondary identification step depending on the specific server implementation.
  • Parameters
    [in]newValueThe version string.
    [out]retvalThe current version string.
The documentation for this interface was generated from the following file: