USB Microphone Error Codes

Syntax

/*
 * Error Codes
 */
#define USB_MIC_ERROR_NONE          0
#define USB_MIC_ERROR_NOT_SUP       (-1)
#define USB_MIC_ERROR_INV_ARG       (-2)
#define USB_MIC_ERROR_INV_STATE     (-3)
#define USB_MIC_ERROR_NO_MEM        (-4)
#define USB_MIC_ERROR_ALREADY_OPEN  (-5)
#define USB_MIC_ERROR_NOT_OPEN      (-6)
#define USB_MIC_ERROR_DEVICE        (-7)

Elements

USB_MIC_ERROR_NONE No error occurred performing the requested function.
USB_MIC_ERROR_NOT_SUP This code is returned in the context of setting or getting state. It means that the requested subfunction is not supported. It is an indication of a program error.
USB_MIC_ERROR_INV_ARG This code is returned whenever an invalid argument is provided in a USB microphone API call. It is an indication of a program error.
USB_MIC_ERROR_INV_STATE This code is returned whenever the internal driver state does not permit the requested function to be performed. It is an indication of a program error.
USB_MIC_ERROR_NO_MEM Internal error, not returned by any API.
USB_MIC_ERROR_ALREADY_OPEN This error code is returned when a function such as USBMICOpen is called more than once without closing it first. This logic also applies to USBMICInit and USBMICStart. It is an indication of a program error.
USB_MIC_ERROR_NOT_OPEN This error code is returned when a USB microphone API is called out of sequence, such as calling USBMICStart before calling USBMICOpen. It is an indication of a program error.
USB_MIC_ERROR_DEVICE This error code is returned when the lower layers of the driver stack cannot be opened due to insufficient system resources (semaphore, mutex, handle, etc). Only USBMICInit can return this error code.

See Also

USBMICInit
USBMICOpen
USBMICStart
USBMICGetState
USBMICSetState

Revision History

2013/05/08 Automated cleanup pass.
2012/10/12 Initial version.


CONFIDENTIAL