JCL Help:TJclWaitableTimer.Cancel

 JCL Help: TJclWaitableTimer.Cancel Method

TJclWaitableTimer

► TJclWaitableTimer Methods

[+] TJclWaitableTimer Methods

JEDI Code Library Help

• Packages
  • RTL enhancements
  • Containers
  • Developer Tools
  • VCL enhancements
• Files
  • Classes
  • Interfaces
  • Functions
  • Variables
  • Constants
  • Types
  • Records
• Project summary
• License

Search in JCL Help

 

Search in all projects

 

Summary

Deactivates the waitable timer.

Pascal

 public function Cancel: Boolean;

Return Value

If the function succeeds it returns True, otherwise it returns False. In the latter case you can call GetLastError to get extended error information.

Description

The Cancel method stops the timer before it can be set to the signaled state and cancels any outstanding APC's. Threads that are waiting on the timer remain waiting until the timer is reactivated with SetTimer. If the Timer is already in the signaled state it remains signaled.

About

Donator

Marcel van Brakel

Contributors

Anonymous

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page

The JEDI Code Library source code is hosted at : link to view the current source code, link to the subversion repository