Edit

Share via

waveInPrepareHeader function (mmeapi.h)

  • Article

The waveInPrepareHeader function prepares a buffer for waveform-audio input.

Syntax

MMRESULT waveInPrepareHeader(
  HWAVEIN   hwi,
  LPWAVEHDR pwh,
  UINT      cbwh
);

Parameters

hwi

Handle to the waveform-audio input device.

pwh

Pointer to a WAVEHDR structure that identifies the buffer to be prepared.

cbwh

Size, in bytes, of the WAVEHDR structure.

Return value

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

Return code Description
MMSYSERR_INVALHANDLE
 Specified device handle is invalid.
MMSYSERR_NODRIVER
 No device driver is present.
MMSYSERR_NOMEM
 Unable to allocate or lock memory.

Remarks

The lpData, dwBufferLength, and dwFlags members of the WAVEHDR structure must be set before calling this function (dwFlags must be zero).

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

Waveform Audio

Waveform Functions