CallbackFileSystem.ResetTimeout method
Filter:
Pascal C++ (Lib) C++ (VCL) C++ (.NET) C# VB.NETOverview
Resets timeout for current operation.
Declaration
[Pascal]
function ResetTimeout(Timeout: Integer) : boolean;
[C++ (Lib)]
bool ResetTimeout(unsigned long Timeout);
[C++ (VCL)]
bool __fastcall ResetTimeout(long Timeout);
[C++ (.NET)]
bool ResetTimeout(long Timeout);
[C#]
bool ResetTimeout(int Timeout);
[VB.NET]
Function ResetTimeout(ByVal Timeout As Integer) As Boolean
Parameters
- Timeout - specifies the expected time for the current operation.
Return values
TRUE / true if the function succeeded or FALSE / false if the function failed.
Description
This method may be called only from callbacks / event handlers. It is used to tell the Callback File System that request processing takes longer and processing of the callback may take time up to specified in Timeout parameter. Timeout timer is reset to 0 and counting of time to Timeout) is started from 0.
Timeout is specified in milliseconds. The value of 0 (zero) means "callback will work as long as it needs". It's good idea to set timeout to 0 when you do debugging of your callback functions. Remember to set timeout to some reasonable value (for example, 30 seconds) for release version.