mciSetYieldProc function

Article
06/06/2016

The mciSetYieldProc function sets the address of a procedure to be called periodically when an MCI device is waiting for a command to finish because the "wait" (MCI_WAIT) flag was specified.

Syntax

UINT mciSetYieldProc(
   MCIDEVICEID IDDevice,
   YIELDPROC   yp,
   DWORD       dwYieldData
);

Parameters

IDDevice
Identifier of the device to assign a procedure to.
yp
Pointer to the procedure to call when yielding for the specified device. If this parameter is NULL, the function disables any existing yield procedure.
dwYieldData
Data to be sent to the yield procedure when it is called for the specified device.

Return value

Returns TRUE if successful or FALSE otherwise.

Remarks

This function overrides any previous yield procedure for this 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