mciGetYieldProc function

The mciGetYieldProc function retrieves the address of the callback function associated with the "wait" (MCI_WAIT) flag. The callback function is called periodically while an MCI device waits for a command specified with the "wait" flag to finish.

Syntax

YIELDPROC mciGetYieldProc(
   MCIDEVICEID IDDevice,
   LPDWORD     lpdwYieldData
);

Parameters

  • IDDevice
    MCI device being monitored (the device performing an MCI command).

  • lpdwYieldData
    Pointer to a buffer containing yield data to be passed to the callback function. This parameter can be NULL if there is no yield data.

Return value

Returns the address of the current yield callback function if successful or NULL if the device identifier is invalid.

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

MCI

MCI Functions