| INT FreezeEvents( |
| |
BOOL bFreeze |
|
| ); |
The FreezeEvents method is used to suspend and resume event
handling by the client.
Parameters
- bFreeze
- A non-zero value specifies that event handling should be
suspended by the client. A zero value specifies that event handling
should be resumed.
Return Value
If the method succeeds, the return value is zero. If the method
fails, the return value is FTP_ERROR. To get extended error
information, call GetLastError.
Remarks
This method should be used when the application does not want to
process events, such as when a modal dialog is being displayed. When
events are suspended, all client events are queued. If events are
re-enabled at a later point, those queued events will be sent to the
application for processing. Note that only one of each event will be
generated. For example, if the client has suspended event handling,
and four read events occur, once event handling is resumed only one
of those read events will be posted to the client. This prevents the
application from being flooded by a potentially large number of
queued events.
Requirements
Minimum Desktop Platform: Windows 7 Service Pack 1
Minimum Server Platform: Windows Server 2008 R2 Service Pack 1
Header File: cstools11.h
Import Library: csftpv11.lib
Unicode: Implemented as Unicode and ANSI versions
See Also
DisableEvents,
EnableEvents,
RegisterEvent
|