MIDI.InputDevicesInfoGet method |
|
Remarks
After completing the enumeration, started through the MIDI.InputDevicesEnum method, of MIDI input devices installed inside the system, allows retrieving information about a specific MIDI input device.
For further details about the use of MIDI protocol see the MIDIMan class section and the How to deal with MIDI protocol tutorial.
Syntax
[Visual Basic] Public Function InputDevicesInfoGet ( nDeviceIndex as Int16, ByRef nManufacturerId as Int32, ByRef nProductId as Int32, ByRef bIsEnabled as Boolean, ByRef bIsStarted as Boolean ) as String |
[C#] public string InputDevicesInfoGet ( Int16 nDeviceIndex, ref Int32 nManufacturerId, ref Int32 nProductId, ref Int32 bIsEnabled, ref Int32 bIsStarted ); |
[C++] public: string InputDevicesInfoGet ( Int16 nDeviceIndex, Int32 __gc *nManufacturerId, Int32 __gc *nProductId, Int32 __gc *bIsEnabled, Int32 __gc *bIsStarted ); |
Parameter |
Description |
||||||
|
|
||||||
nDeviceIndex |
Number representing the zero-based index of the MIDI input device. The number of available MIDI input devices installed inside the system can be obtained directly through the MIDI.InputDevicesEnum method or, after having performed the enumeration, through the MIDI.InputDevicesCountGet method. |
||||||
nManufacturerId |
Reference that, on return from the method call, will contain the number representing the manufacturer identifier for the MIDI device. The list of known identifiers can be found inside the MSDN website |
||||||
nProductId |
Reference that, on return from the method call, will contain the number representing the product identifier for the MIDI device. The list of known identifiers can be found inside the MSDN website |
||||||
bIsEnabled |
Reference that, on return from the method call, will report if the MIDI input device is enabled. Supported values are the following:
|
||||||
bIsStarted |
Reference that, on return from the method call, will report if the MIDI input device is started. Supported values are the following:
|
Return value
Value |
Meaning |
|
|
Empty string |
An error occurred (see the LastError property for further error details) |
Valid string |
String containing the friendly name of the MIDI input device |