MCI_ESCAPE

This message sends messages directly to the vendor-specific driver (VSD) or the device driver. This message is not interpreted by the media control interface driver (MCD).

Syntax

param1
ULONG ulParam1; /* Flags for escape operation. */

param2
PMCI_ESCAPE_PARMS pParam2; /* Pointer to the MCI_ESCAPE_PARMS data structure. */

Parameters

ulParam1 (ULONG) - input

This parameter can contain any of the following flags:

MCI_NOTIFY A notification message will be posted to the window specified in the hwndCallback parameter of the data structure pointed to by the pParam2 parameter. The notification will be posted when the action indicated by this message is completed or when an error occurs.
MCI_WAIT Control is not to be returned until the action indicated by this message is completed or an error occurs.
MCI_ESCAPE_STRING This flag indicates a command string is specified in the pszCommand field of the MCI_ESCAPE_PARMS data structure.

pParam2 (PMCI_ESCAPE_PARMS) - input: A pointer to the MCI_ESCAPE_PARMS data structure.

Returns

rc (ULONG) - returns

Return codes indicating success or type of failure:

MCIERR_SUCCESS If the function succeeds, 0 is returned.
MCIERR_INVALID_DEVICE_ID The device ID is not valid.
MCIERR_INSTANCE_INACTIVE The device ID is currently inactive. Issue MCI_ACQUIREDEVICE to make the device ID active.
MCIERR_MISSING_FLAG A required flag is missing.
MCIERR_UNSUPPORTED_FLAG Given flag is unsupported for this device.
MCIERR_INVALID_CALLBACK_HANDLE Given callback handle is invalid.
MCIERR_HARDWARE Device hardware error.
MCIERR_UNSUPPORTED_FUNCTION Unsupported function.
MCIERR_INVALID_FLAG Flag (ulParam1) is invalid.
MCIERR_FLAGS_NOT_COMPATIBLE Flags cannot be used together.
MCIERR_MISSING_PARAMETER Required parameter is missing.

Remarks

MCI_ESCAPE provides a means of passing a command string directly to a VSD or device driver for execution. Support of this message is optional.