SecureBridge ComponentsTScSFTPServer.OnRetrieveAttributesByHandle
type
TScSFTPServerRetrieveAttributesByHandleEvent = procedure(Sender: TObject; SFTPSessionInfo: TScSFTPSessionInfo; Data: TObject; const ReqAttrs: TScSFTPAttributes; Attributes: TScSFTPFileAttributes; var Error: TScSFTPError) of object;
property OnRetrieveAttributesByHandle: TScSFTPServerRetrieveAttributesByHandleEvent;
Description
The OnRetrieveAttributesByHandle event occurs on request from an SFTP client to retrieve the attributes for a file specified by the Data object. The OnRetrieveAttributesByHandle event handler should receive the file attributes and write them to the Attributes object.
You can call the DefaultRetrieveAttributesByHandle method to execute this operation or write your own implementation.
Parameters:
| • | Sender - the object whose event handler is called. |
| • | SFTPSessionInfo - contains the information about the current SFTP session. |
| • | Data - specifies the information about a requested file or directory as the TScHandle or TScSearchRec object or any user's object. Usually this object is previously returned by the DefaultOpenFile or DefaultOpenDirectory methods, or the OnOpenFile or OnOpenDirectory event handlers. |
| • | ReqAttrs - specifies the file attributes which should be retrieving. |
| • | Attributes - an object to which the attributes of the requested file should be written. |
| • | Error - a parameter to pass the information about an error that can arise when retrieving file attributes. |
See also