TElSftpClient.CloseHandle method

TElSftpClient.CloseHandle

Closes the opened file handle.

Declaration

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

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

[Pascal]
    function CloseHandle(Handle : TSBSftpFileHandle): Boolean;
    procedure CloseHandleSync(Handle: TSBSftpFileHandle);
    type TSBSftpFileHandle = ByteArray;

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

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

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

Parameters

Handle - Active file handle

Return value

True if operation was completed successfully;
False otherwise.

Description

Use this method to close the active file handle. After passing to this function the handle becomes invalid and should not be used.