TElSimpleSFTPClient.CloseHandle method

TElSimpleSFTPClient.CloseHandle

TElSimpleSFTPClient See also

Filter: C# VB.NET Pascal C++ PHP Java

Closes the opened file handle.

Declaration

[C#]
void CloseHandle(byte[] Handle);

[VB.NET]
Sub CloseHandle(ByVal Handle As Byte())

[Pascal]
procedure CloseHandle(const Handle : TSBSftpFileHandle);

[C++]
void CloseHandle(const std::vector<uint8_t> &Handle);

[PHP]
void CloseHandle(array of byte|string|NULL $Handle)

[Java]
void closeHandle(byte[] Handle);

Parameters

Handle - Active file handle

Description

Use this method to close the active file handle. After passing to this function the handle becomes invalid and should not be used.
In case of error, EElSFTPError exception containing SFTP error code, is raised. For more information on error handling, please read the corresponding how-to article.