Discuss this help topic in SecureBlackbox Forum

TElSimpleSFTPClient.SetAttributesByHandle

TElSimpleSFTPClient     See also     


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


Sets the attributes for a specified open file

Declaration

[C#/Java]
    bool SetAttributesByHandle(byte[] Handle, TElSftpFileAttributes Attributes);
    void SetAttributesByHandleSync(byte[] Handle, TElSftpFileAttributes Attributes);

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

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

[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)

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. You need to set the attributes via various properties of Attributes parameter, also you need to adjust Attributes.IncludedAttributes property to specify attributes which you need to set.


    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.

See also:     SetAttributes     RequestAttributes    

Discuss this help topic in SecureBlackbox Forum