MCI_INFO

This MCI command message obtains string information from a device. All devices respond to this message. The parameters and flags available for this message depend on the selected device. Information is returned in the lpstrReturn field of the data structure identified by lpInfo. The dwReturnSize field specifies the buffer length for the return data.

Parameters

DWORD lParam1

The following standard and command-specific flags apply to all devices:

MCI_NOTIFY

Specifies that MCI should post the MM_MCINOTIFY message when this command completes. The window to receive this message is specified in the dwCallback field of the data structure identified by lpInfo.

MCI_WAIT

Specifies that the query operation should finish before MCI returns control to the application.

MCI_INFO_PRODUCT

Obtains a description of the hardware associated with a device. Devices should supply a description that identifies both the driver and the hardware used.

LPMCI_INFO_PARMS lParam2

Specifies a far pointer to the MCI_INFO_PARMS data structure. (Devices with extended command sets might replace this data structure with a device-specific data structure.)

Animation Extensions

DWORD lParam1

The following additional flags apply to animation devices:

MCI_INFO_FILE

Obtains the filename of the current file. This flag is only supported by devices that return TRUE to the MCI_GETDEVCAPS_USES_FILES query.

MCI_ANIM_INFO_TEXT

Obtains the window caption.

LPMCI_INFO_PARMS lParam2

Specifies a far pointer to the MCI_INFO_PARMS data structure.

Video Overlay Extensions

DWORD lParam1

The following additional flags apply to video overlay devices:

MCI_INFO_FILE

Obtains the filename of the current file. This flag is only supported by devices that return TRUE to the MCI_GETDEVCAPS_USES_FILES query.

MCI_OVLY_INFO_TEXT

Obtains the caption of the window associated with the overlay device.

LPMCI_INFO_PARMS lParam2

Specifies a far pointer to the MCI_INFO_PARMS data structure.

Waveform Audio Extensions

DWORD lParam1

The following additional flags apply to waveform audio devices:

MCI_INFO_FILE

Obtains the filename of the current file. This flag is supported by devices that return TRUE to the MCI_GETDEVCAPS_USES_FILES query.

MCI_WAVE_INPUT

Obtains the product name of the current input.

MCI_WAVE_OUTPUT

Obtains the product name of the current output.

LPMCI_INFO_PARMS lParam2

Specifies a far pointer to the MCI_INFO_PARMS data structure.

Return Value

Returns zero if successful. Otherwise, it returns an MCI error code.

Comments

If an application requests return-string information and it does not supply a buffer large enough to hold it, your device driver should fill the buffer and truncate the string. Return MCIERR_PARAM_OVERFLOW to indicate the information in the buffer was truncated.