SecureBridge ComponentsTScSFTPServer.OnUnBlockFile
type
TScSFTPServerUnBlockFileEvent = procedure(Sender: TObject; SFTPSessionInfo: TScSFTPSessionInfo; Data: TObject; const Offset, Len: Int64; var Error: TScSFTPError) of object;
property OnUnBlockFile: TScSFTPServerUnBlockFileEvent;
Description
The OnUnBlockFile event occurs on request from an SFTP client to remove a previously acquired byte-range lock on the file specified by the Data object.
You can call the DefaultUnBlockFile 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 an unblocking file as the TScHandle object or any user's object. Usually this object is previously returned by the DefaultOpenFile method or the OnOpenFile event handler. |
| • | Offset - the beginning of the byte-range to lock. |
| • | Len - the number of bytes in the range to lock. The special value 0 means lock from Offset to the end of the file. |
| • | Error - a parameter to pass the information about an error that can arise when unblocking a file. |
See also