Edit

Share via

midiOutGetDevCapsA function (mmeapi.h)

  • Article

The midiOutGetDevCaps function queries a specified MIDI output device to determine its capabilities.

Syntax

MMRESULT midiOutGetDevCapsA(
  UINT_PTR       uDeviceID,
  LPMIDIOUTCAPSA pmoc,
  UINT           cbmoc
);

Parameters

uDeviceID

Identifier of the MIDI output device. The device identifier specified by this parameter varies from zero to one less than the number of devices present. The MIDI_MAPPER constant is also a valid device identifier.

This parameter can also be a properly cast device handle.

pmoc

Pointer to a MIDIOUTCAPS structure. This structure is filled with information about the capabilities of the device.

cbmoc

Size, in bytes, of the MIDIOUTCAPS structure. Only cbMidiOutCaps bytes (or less) of information is copied to the location pointed to by lpMidiOutCaps. If cbMidiOutCaps is zero, nothing is copied, and the function returns MMSYSERR_NOERROR.

Return value

Returns MMSYSERR_NOERROR if successful or an error otherwise. Possible error values include the following.

Return code Description
MMSYSERR_BADDEVICEID
 The specified device identifier is out of range.
MMSYSERR_INVALPARAM
 The specified pointer or structure is invalid.
MMSYSERR_NODRIVER
 The driver is not installed.
MMSYSERR_NOMEM
 The system is unable to load mapper string description.

Remarks

To determine the number of MIDI output devices present in the system, use the midiOutGetNumDevs function.

Note

The mmeapi.h header defines midiOutGetDevCaps as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header mmeapi.h (include Windows.h)
Library Winmm.lib
DLL Winmm.dll

See also

MIDI Functions