TElSftpClient.SetAttributesByHandle method

TElSftpClient.SetAttributesByHandle

Sets the attributes for a specified open file

Declaration

[C#]
bool SetAttributesByHandle(byte[] Handle, TElSftpFileAttributes Attributes);

[VB.NET]
Function SetAttributesByHandle(ByVal Handle As Byte(), ByVal Attributes As TElSftpFileAttributes) As Boolean

[Pascal]
    function SetAttributesByHandle(const Handle: TSBSftpFileHandle; Attributes: TElSftpFileAttributes):Boolean;
    procedure SetAttributesByHandleSync(const Handle: TSBSftpFileHandle; Attributes: TElSftpFileAttributes);

    type TSBSftpFileHandle = ByteArray;

[C++]
bool SetAttributesByHandle(const std::vector<uint8_t> &Handle, TElSftpFileAttributes &Attributes);
bool SetAttributesByHandle(const std::vector<uint8_t> &Handle, TElSftpFileAttributes *Attributes);

[PHP]
bool SetAttributesByHandle(array of byte|string|NULL $Handle, TElSftpFileAttributes $Attributes)

[Java]
boolean setAttributesByHandle(byte[] Handle, TElSftpFileAttributes Attributes);

Parameters

Handle - handle of the open file
Attributes - specifies the new attributes for a file

Return value

True if operation was completed successfully;
False otherwise.

Description

Use this method to set attributes for a specified open file. If the attributes were successfully set, the OnSuccess event is fired. The OnError event is fired otherwise.

Discuss this help topic in SecureBlackbox Forum