//-----------------------------------------------------------------------
// <copyright file="RP1210_Returns.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 DynamicApiLoading.Api.Dynamic.RP1210
{
    /// <summary>
    /// RP1210 API Return Values.
    /// </summary>
    [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1717:OnlyFlagsEnumsShouldHavePluralNames", Justification = "This is an enum.")]
    public enum RP1210_Returns
    {
        /// <summary>
        /// No Error
        /// </summary>
        NO_ERRORS = 0,

        /// <summary>
        /// The API DLL was not initialized.
        /// </summary>
        ERR_DLL_NOT_INITIALIZED = 128,

        /// <summary>
        /// The identifier for the client to be disconnected was invalid.
        /// </summary>
        ERR_INVALID_CLIENT_ID = 129,

        /// <summary>
        /// A client is already connected to the specified device.
        /// </summary>
        ERR_CLIENT_ALREADY_CONNECTED = 130,

        /// <summary>
        /// The maximum number of connections has been reached.
        /// </summary>
        ERR_CLIENT_AREA_FULL = 131,

        /// <summary>
        /// An error occurred in the process of memory de-allocation.
        /// </summary>
        ERR_FREE_MEMORY = 132,

        /// <summary>
        /// The API DLL could not allocate enough memory to create the client.
        /// </summary>
        ERR_NOT_ENOUGH_MEMORY = 133,

        /// <summary>
        /// The specified device ID is invalid.
        /// </summary>
        ERR_INVALID_DEVICE = 134,

        /// <summary>
        /// The specified device is already in use and does not have the ability
        /// to maintain connections with multiple clients simultaneously.
        /// </summary>
        ERR_DEVICE_IN_USE = 135,

        /// <summary>
        /// The specified protocol is invalid or unsupported or the extended
        /// connect string (fpchProtocol) was incorrect or unsupported.
        /// </summary>
        ERR_INVALID_PROTOCOL = 136,

        /// <summary>
        /// The API DLL’s transmit message queue is full.
        /// </summary>
        ERR_TX_QUEUE_FULL = 137,

        /// <summary>
        /// The API DLL’s transmit message queue is corrupt.
        /// </summary>
        ERR_TX_QUEUE_CORRUPT = 138,

        /// <summary>
        /// The API DLL’s receive message queue is full.
        /// </summary>
        ERR_RX_QUEUE_FULL = 139,

        /// <summary>
        /// The API DLL’s receive message queue is corrupt.
        /// </summary>
        ERR_RX_QUEUE_CORRUPT = 140,

        /// <summary>
        /// The message being sought to be received is too long for the user’s buffer.
        /// </summary>
        ERR_MESSAGE_TOO_LONG = 141,

        /// <summary>
        /// The device is not responding.
        /// </summary>
        ERR_HARDWARE_NOT_RESPONDING = 142,

        /// <summary>
        /// The command number is not supported by the API DLL.
        /// </summary>
        ERR_COMMAND_NOT_SUPPORTED = 143,

        /// <summary>
        /// A command parameter is not supported.
        /// </summary>
        ERR_INVALID_COMMAND = 144,

        /// <summary>
        /// Tx message status error.
        /// </summary>
        ERR_TXMESSAGE_STATUS = 145,

        /// <summary>
        /// The API was not able to claim the requested address.
        /// </summary>
        ERR_ADDRESS_CLAIM_FAILED = 146,

        /// <summary>
        /// Can't set priority.
        /// </summary>
        ERR_CANNOT_SET_PRIORITY = 147,

        /// <summary>
        /// Indicates RP1210_ClientDisconnect was called on the nClientID.
        /// </summary>
        ERR_CLIENT_DISCONNECTED = 148,

        /// <summary>
        /// Only one connection is allowed in the requested Mode.
        /// </summary>
        ERR_CONNECT_NOT_ALLOWED = 149,

        /// <summary>
        /// Change Mode failed.
        /// </summary>
        ERR_CHANGE_MODE_FAILED = 150,

        /// <summary>
        /// The API was not able to transmit a CAN packet due to the CAN hardware being in a BUS_OFF condition.
        /// </summary>
        ERR_BUS_OFF = 151,

        /// <summary>
        /// The API was not able to request an address.
        /// </summary>
        ERR_COULD_NOT_TX_ADDRESS_CLAIMED = 152,

        /// <summary>
        /// The API was forced to concede the address to another node on the network.
        /// </summary>
        ERR_ADDRESS_LOST = 153,

        /// <summary>
        /// The error code provided does not have an associated textual representation associated with it.
        /// </summary>
        ERR_CODE_NOT_FOUND = 154,

        /// <summary>
        /// This was a legacy Windows 3.1 return code.
        /// </summary>
        ERR_BLOCK_NOT_ALLOWED = 155,

        /// <summary>
        /// The API was not able to reset the device because more than one client is connected.
        /// </summary>
        ERR_MULTIPLE_CLIENTS_CONNECTED = 156,

        /// <summary>
        /// J1939 client never protected an address. This return code is for J1939 only.
        /// </summary>
        ERR_ADDRESS_NEVER_CLAIMED = 157,

        /// <summary>
        /// Window handle required.
        /// </summary>
        ERR_WINDOW_HANDLE_REQUIRED = 158,

        /// <summary>
        /// Returned if an error has occurred queuing the message.
        /// </summary>
        ERR_MESSAGE_NOT_SENT = 159,

        /// <summary>
        /// Max notify exceeded.
        /// </summary>
        ERR_MAX_NOTIFY_EXCEEDED = 160,

        /// <summary>
        /// Max filters exceeded.
        /// </summary>
        ERR_MAX_FILTERS_EXCEEDED = 161,

        /// <summary>
        /// Hardware status change.
        /// </summary>
        ERR_HARDWARE_STATUS_CHANGE = 162,

        /// <summary>
        /// INI file not found.
        /// </summary>
        ERR_INI_FILE_NOT_IN_WIN_DIR = 202,

        /// <summary>
        /// INI section not found.
        /// </summary>
        ERR_INI_SECTION_NOT_FOUND = 204,

        /// <summary>
        /// INI key not found.
        /// </summary>
        ERR_INI_KEY_NOT_FOUND = 205,

        /// <summary>
        /// Invalid key string.
        /// </summary>
        ERR_INVALID_KEY_STRING = 206,

        /// <summary>
        /// Device not supported.
        /// </summary>
        ERR_DEVICE_NOT_SUPPORTED = 207,

        /// <summary>
        /// Invalid port parameter.
        /// </summary>
        ERR_INVALID_PORT_PARAM = 208,

        /// <summary>
        /// Command timed out.
        /// </summary>
        ERR_COMMAND_TIMED_OUT = 213,

        /// <summary>
        /// Operating System not supported.
        /// </summary>
        ERR_OS_NOT_SUPPORTED = 220,

        /// <summary>
        /// Command queue is full.
        /// </summary>
        ERR_COMMAND_QUEUE_IS_FULL = 222,

        /// <summary>
        /// Can't set baud rate.
        /// </summary>
        ERR_CANNOT_SET_CAN_BAUDRATE = 224,

        /// <summary>
        /// Can't claim broadcast address.
        /// </summary>
        ERR_CANNOT_CLAIM_BROADCAST_ADDRESS = 225,

        /// <summary>
        /// Out of address resources.
        /// </summary>
        ERR_OUT_OF_ADDRESS_RESOURCES = 226,

        /// <summary>
        /// The API was not able to release the requested address.
        /// </summary>
        ERR_ADDRESS_RELEASE_FAILED = 227,

        /// <summary>
        /// Communication device is in use.
        /// </summary>
        ERR_COMM_DEVICE_IN_USE = 230,

        /// <summary>
        /// DLL not found.
        /// </summary>
        DG_DLL_NOT_FOUND = 254,

        /// <summary>
        /// Busy sending.
        /// </summary>
        DG_BUSY_SENDING = 255,

        /// <summary>
        /// Data link conflict.
        /// </summary>
        ERR_DATA_LINK_CONFLICT = 441,

        /// <summary>
        /// Adapter not responding.
        /// </summary>
        ERR_ADAPTER_NOT_RESPONDING = 453,

        /// <summary>
        /// Another application already has the baud rate set non-standard.
        /// </summary>
        ERR_CAN_BAUD_SET_NONSTANDARD = 454,

        /// <summary>
        /// RP1210_Disallow_Further_Connections was issued previously.
        /// <para>
        /// Added to RP1210B was the ability to disallow another applications or clients from issuing a client connection
        /// through the vehicle adapter. This allows time-sensitive applications or applications that “must” be the
        /// only application/client with a connection to the databus to operate unimpeded by other applications/clients.
        /// This command can only be issued if there are no other applications using the specified databus. Once this
        /// client connection terminates, other clients will be allowed to connect. This command would be common
        /// in end-of-line programming stations.
        /// </para>
        /// </summary>
        ERR_MULTIPLE_CONNECTIONS_NOT_ALLOWED_NOW = 455,

        /// <summary>
        /// Another application already has the baud rate set non-standard.
        /// </summary>
        ERR_J1708_BAUD_SET_NONSTANDARD = 456,

        /// <summary>
        /// Another application already has the baud rate set non-standard.
        /// </summary>
        ERR_J1939_BAUD_SET_NONSTANDARD = 457,

        /// <summary>
        /// Another application already has the baud rate set non-standard.
        /// </summary>
        ERR_ISO15765_BAUD_SET_NONSTANDARD = 458
    }
}