TElSimpleSFTPClient.SetAttributesByHandle method

TElSimpleSFTPClient.SetAttributesByHandle

Sets the attributes for the specified opened file

Declaration

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

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

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

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

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

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

Parameters

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

Return value

Returns True if the operation was completed successfully, and False otherwise.

Description

Use this method to set the attributes for the specified opened file. You need to set the attributes via the Attributes parameter. You also have to adjust the Attributes.IncludedAttributes property.
In case of error, EElSFTPError exception containing the SFTP error code, is raised. For more information on error handling, please read the corresponding how-to article.

Discuss this help topic in SecureBlackbox Forum