Close connection

Explicitly closes the passed connection

Parameters

Function CloseConnection(Val Connection) Export

Parameter	CLI option	Type	Required	Description
Connection	-	Arbitrary	✔	AddIn object with open connection

Returns

Structure Of KeyAndValue - Result of connection termination

Advanced call ?

This method has no additional advanced call parameters.

Caution

NOCLI: this method is not available in CLI version

1C:Enterprise/OneScript code example

    Host = "172.33.0.13";
    Port = "2222";

    UseProxy          = True;
    ProxySettings     = Undefined;
    AuthorizationType = "By login and password";

    If AuthorizationType = "By login and password" Then

        Login    = "bayselonarrend";
        Password = "12we...";

        SFTPSettings = OPI_SFTP.GetSettingsLoginPassword(Host, Port, Login, Password);

    ElsIf AuthorizationType = "By key" Then

        Login      = "bayselonarrend";
        PrivateKey = "./ssh_key";
        PublicKey  = "./ssh_key.pub";

        SFTPSettings = OPI_SFTP.GetSettingsPrivateKey(Host, Port, Login, PrivateKey, PublicKey);

    ElsIf AuthorizationType = "Keyboard interactive" Then

        Login    = "bayselonarrend";
        Password = "12we...";

        AnswersArray = New Array;
        AnswersArray.Add(Password);

        SFTPSettings = OPI_SFTP.GetSettingsKI(Host, Port, Login, AnswersArray);

    Else

        Login        = "bayselonarrend";
        SFTPSettings = OPI_SFTP.GetSettingsViaAgent(Host, Port, Login);

    EndIf;

    If UseProxy Then

        ProxyType = "http"; // http, socks5, socks4

        ProxyAddress  = "127.0.0.1";
        ProxyPort     = "8071";
        ProxyLogin    = "proxyuser";
        ProxyPassword = "12we...";

        ProxySettings = OPI_SFTP.GetProxySettings(ProxyAddress, ProxyPort, ProxyType, ProxyLogin, ProxyPassword);

    EndIf;

    Connection = OPI_SFTP.CreateConnection(SFTPSettings, ProxySettings);

    If OPI_SFTP.IsConnector(Connection) Then
        Result = OPI_SFTP.CloseConnection(Connection);
    Else
        Result = Connection; // Error of connection
    EndIf;

Result

{
 "result": true
}