waveInUnprepareHeader

Syntax

WORD waveInUnprepareHeader(hWaveIn, lpWaveInHdr, wSize)

This function cleans up the preparation performed by waveInPrepareHeader. The function must be called after the device driver fills a data buffer and returns it to the application. You must call this function before freeing the data buffer.

Parameters

HWAVEIN hWaveIn

Specifies a handle to the waveform input device.

LPWAVEHDR lpWaveInHdr

Specifies a pointer to a WAVEHDR structure identifying the data buffer to be cleaned up.

WORD wSize

Specifies the size of the WAVEHDR structure.

Return Value

Returns zero if the function was successful. Otherwise, it returns an error number. Possible error returns are:

MMSYSERR_INVALHANDLE

Specified device handle is invalid.

WAVERR_STILLPLAYING

lpWaveInHdr is still in the queue.

Comments

This function is the complementary function to waveInPrepareHeader. You must call this function before freeing the data buffer with GlobalFree. After passing a buffer to the device driver with waveInAddBuffer, you must wait until the driver is finished with the buffer before calling waveInUnprepareHeader. Unpreparing a buffer that has not been prepared has no effect, and the function returns zero.

See Also

waveInPrepareHeader