waveOutWrite function

The waveOutWrite function sends a data block to the given waveform-audio output device.

Syntax

MMRESULT waveOutWrite(
   HWAVEOUT  hwo,
   LPWAVEHDR pwh,
   UINT      cbwh
);

Parameters

  • hwo
    Handle to the waveform-audio output device.

  • pwh
    Pointer to a WAVEHDR structure containing information about the data block.

  • 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.

WAVERR_UNPREPARED

The data block pointed to by the pwh parameter hasn't been prepared.

 

Remarks

When the buffer is finished, the WHDR_DONE bit is set in the dwFlags member of the WAVEHDR structure.

The buffer must be prepared with the waveOutPrepareHeader function before it is passed to waveOutWrite. Unless the device is paused by calling the waveOutPause function, playback begins when the first data block is sent to the device.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Mmsystem.h (include Windows.h)

Library

Winmm.lib

DLL

Winmm.dll

See also

Waveform Audio

Waveform Functions