//-----------------------------------------------------------------------
// <copyright file="NativeMethods.cs" company="bedug.com">
//     Copyright © 2012 Nils Hammar. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
/*
 * Software to access vehicle information via the OBD-II connector.
 * 
 * Copyright © 2012 Nils Hammar
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 * 
 * Alternative licensing is possible, see the licensing document.
 * 
 * The above text may not be removed or modified.
 */

namespace VectorComm
{
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Runtime.InteropServices;
    using System.Text;

    /// <summary>
    /// Native methods for Vector API.
    /// </summary>
    public static class NativeMethods
    {
        /// <summary>
        /// Waits until the specified object is in the signaled state or the time-out interval elapses.
        /// </summary>
        /// <param name="hHandle">Handle to object.</param>
        /// <param name="dwMilliseconds">Wait time.</param>
        /// <returns>Status code, see WaitResults.</returns>
        [DllImport("kernel32", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
        internal static extern int WaitForSingleObject(IntPtr hHandle, int dwMilliseconds);
    }

    /// <summary>
    /// Possible states of WaitForSingleObject.
    /// </summary>
    public enum WaitResult : int
    {
        /// <summary>
        /// Wait object zero.
        /// </summary>
        WAIT_OBJECT_0 = 0x0,

        /// <summary>
        /// Wait was abandoned.
        /// </summary>
        WAIT_ABANDONED = 0x80,

        /// <summary>
        /// Wait had a timeout.
        /// </summary>
        WAIT_TIMEOUT = 0x102,

        /// <summary>
        /// Wait is infinite.
        /// </summary>
        INFINITE = 0xFFFF,

        /// <summary>
        /// Wait failed.
        /// </summary>
        WAIT_FAILED = 0xFFFFFFF
    }
}