Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

                                                 ◄Contents► ◄Index► ◄Back►
────────────────────────────────────────────────────────────────────────────
MCI_LOAD
 
        This MCI command message loads a file. Support of this message
        by a device is optional. The parameters and flags for this
        message vary according to the selected device.
 
Parameters
        DWORD dwFlags
            The following flags apply to all devices supporting
            MCI_LOAD:
 
            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 lpLoad.
 
            MCI_WAIT
                Specifies that the load operation should finish before
                MCI returns control to the application.
 
            MCI_LOAD_FILE
                Indicates the lpfilename field of the data structure
                identified by lpLoad contains a pointer to a buffer
                containing the file name.
 
        LPMCI_LOAD_PARMS lpLoad
            Specifies a far pointer to the MCI_LOAD_PARMS data
            structure. (Devices with additional parameters might replace
            this data structure with a device-specific data structure.)
 
        Video Overlay Extensions
 
        DWORD dwFlags
            The following additional flags apply to video overlay
            devices supporting MCI_LOAD:
 
            MCI_OVLY_RECT
                Specifies that the rc field of the data structure
                identified by lpLoad contains a valid display rectangle
                that identifies the area of the video buffer to update.
 
        LPMCI_OVLY_LOAD_PARMS lpLoad
            Specifies a far pointer to a MCI_OVLY_LOAD_PARMS data
            structure.
 
Return value
        Returns zero if successful. Otherwise, it returns an MCI error
        code.
 
Comments
        This command applies to video overlay devices.
 
See also
        MCI_SAVE
 
                                       -♦-