break

The break command specifies a key to abort a command that was invoked using the "wait" flag. This command is an MCI system command; it is interpreted directly by MCI.

To send this command, call the mciSendString function with the lpszCommand parameter set as follows.

_stprintf_s(
  lpszCommand, 
  TEXT("break %s %s %s"), 
  lpszDeviceID, 
  lpszVirtKey, 
  lpszFlags
); 

Parameters

lpszDeviceID

Identifier of an MCI device. This identifier or alias is assigned when the device is opened.

lpszVirtKey

One of the following flags.

Value Meaning
on virtual key code Specifies the key that aborts a command that was started using the "wait" flag.
off Disables the current break key.

lpszFlags

Can be "wait", "notify", or both. For digital-video and VCR devices, "test" can also be specified. For more information about these flags, see The Wait, Notify, and Test Flags.

Return Values

Returns zero if successful or an error otherwise.

Remarks

When the break key is enabled and the user presses the key identified by the virtual-key code specified in the lpszVirtKey parameter, the device returns control to the application. If possible, the command continues execution.

The following command sets F2 as the break key for the "mysound" device:

break mysound on 113

Requirements

  Windows NT/2000/XP: Included in Windows NT 3.1 and later.
  Windows 95/98/Me: Included in Windows 95 and later.

See Also

MCI, MCI Command Strings

Show: