Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Support Forum
Download Visual Studio Add-In

Terms of Use
Privacy Policy
timesetevent (winmm)
 
.
Summary
TODO - a short description

C# Signature:

[DllImport("winmm.dll", SetLastError=true)]
static extern UInt32 timeSetEvent( UInt32 msDelay, UInt32 msResolution,
            TimerEventHandler handler, ref UInt32 userCtx, UInt32 eventType );

VB Signature:

Declare Function timeSetEvent Lib "winmm.dll" (TODO) As TODO

User-Defined Types:

TimerEventHandler

Alternative Managed API:

System.Threading.Timer

Notes:

None.

Tips & Tricks:

Please add some!

Sample Code:

    public class MMTimer : IDisposable
    {
    //Lib API declarations
    [DllImport("Winmm.dll", CharSet = CharSet.Auto)]
    static extern uint timeSetEvent(uint uDelay, uint uResolution, TimerCallback lpTimeProc, UIntPtr dwUser, uint fuEvent);

    [DllImport("Winmm.dll", CharSet = CharSet.Auto)]
    static extern uint timeKillEvent(uint uTimerID);

    [DllImport("Winmm.dll", CharSet = CharSet.Auto)]
    static extern uint timeGetTime();

    [DllImport("Winmm.dll", CharSet = CharSet.Auto)]
    static extern uint timeBeginPeriod(uint uPeriod);

    [DllImport("Winmm.dll", CharSet = CharSet.Auto)]
    static extern uint timeEndPeriod(uint uPeriod);

    //Timer type definitions
    [Flags]
    public enum fuEvent : uint
    {
        TIME_ONESHOT = 0,      //Event occurs once, after uDelay milliseconds.
        TIME_PERIODIC = 1,
        TIME_CALLBACK_FUNCTION = 0x0000,  /* callback is function */
        //TIME_CALLBACK_EVENT_SET = 0x0010, /* callback is event - use SetEvent */
        //TIME_CALLBACK_EVENT_PULSE = 0x0020  /* callback is event - use PulseEvent */
    }

    //Delegate definition for the API callback
    delegate void TimerCallback(uint uTimerID, uint uMsg, UIntPtr dwUser, UIntPtr dw1, UIntPtr dw2);

    //IDisposable code
    private bool disposed = false;

    public void Dispose()
    {
        Dispose(true);
        GC.SuppressFinalize(this);
    }

    private void Dispose(bool disposing)
    {
        if (!this.disposed)
        {
        if (disposing)
        {
            Stop();
        }
        }
        disposed = true;
    }

    ~MMTimer()
    {
        Dispose(false);
    }

    /// <summary>
    /// The current timer instance ID
    /// </summary>
    uint id = 0;

    /// <summary>
    /// The callback used by the the API
    /// </summary>
    TimerCallback thisCB;

    /// <summary>
    /// The timer elapsed event
    /// </summary>
    public event EventHandler Timer;
    protected virtual void OnTimer(EventArgs e)
    {
        if (Timer != null)
        Timer(this, e);
    }

    public MMTimer()
    {
        //Initialize the API callback
        thisCB = CBFunc;
    }

    /// <summary>
    /// Stop the current timer instance (if any)
    /// </summary>
    public void Stop()
    {
        lock (this)
        {
        if (id != 0)
        {
            timeKillEvent(id);
            Debug.WriteLine("MMTimer " + id.ToString() + " stopped");
            id = 0;
        }
        }
    }

    /// <summary>
    /// Start a timer instance
    /// </summary>
    /// <param name="ms">Timer interval in milliseconds</param>
    /// <param name="repeat">If true sets a repetitive event, otherwise sets a one-shot</param>
    public void Start(uint ms, bool repeat)
    {
        //Kill any existing timer
        Stop();

        //Set the timer type flags
        fuEvent f = fuEvent.TIME_CALLBACK_FUNCTION | (repeat ? fuEvent.TIME_PERIODIC : fuEvent.TIME_ONESHOT);

        lock (this)
        {
        id = timeSetEvent(ms, 0, thisCB, UIntPtr.Zero, (uint)f);
        if (id == 0)
            throw new Exception("timeSetEvent error");
        Debug.WriteLine("MMTimer " + id.ToString() + " started");
        }
    }

    void CBFunc(uint uTimerID, uint uMsg, UIntPtr dwUser, UIntPtr dw1, UIntPtr dw2)
    {
        //Callback from the MMTimer API that fires the Timer event. Note we are in a different thread here
        OnTimer(new EventArgs());
    }
    }

}

Documentation

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Edit This Page
Find References
Show Printable Version
Revisions