mount_media Method

Mounts media in the virtual drive, making it accessible for reading and writing.

Syntax

def mount_media(timeout: int) -> None: ...

Remarks

After using create_storage to create a virtual drive, applications should call this method to "insert storage media" into it. For plug-and-play virtual drives with non-removable media (see storage_type), this method must be called before add_mounting_point is called. For all other virtual drives, add_mounting_point can be called before or after calling this method.

Timeout specifies how many milliseconds the driver will wait for events to execute before cancelling the underlying OS requests; please refer to the Timeouts topic for more information. Valid values are 0, which disables event timeouts, and values greater than or equal to 3000. (Passing a non-zero value less than 3000 will cause this method to fail with an ERROR_IMPLEMENTATION_LIMIT (1292, 0x50C) error code.)

When event timeouts are in effect, event handlers can call reset_timeout to reset the timer if they require additional time to complete an operation.

Note that there are a number of properties that cannot be changed once media is mounted. Such restrictions are noted in properties' documentation as applicable.

If this method encounters any issues during its execution, it raises an exception, and additional information is logged to the Windows system log as described in the Error Reporting and Handling topic.

Note: This method can only be called after creating a virtual drive, and cannot be called within events.

Virtual Drives, Media, and Mounting Points

When applications call the create_storage method, a virtual drive is created. Virtual drives are created without any "media" in them (like a CD drive without a CD inserted), and without any mounting points (drive letters, UNC paths, etc.).

After creating a virtual drive, applications should call mount_media to "insert" virtual storage media into the virtual drive. This call will cause the class's events to start firing; applications must handle these events correctly, or the mount_media call will fail.

Once media has been mounted in the virtual drive, applications should use the add_mounting_point method to add one or more mounting points for the virtual drive. These mounting points make the virtual drive, visible to the system and other applications, allowing them to start accessing the contents of the CBFS-based virtual filesystem.

Note that applications can technically call add_mounting_point before mount_media (except for plug-and-play virtual drives with non-removable media; see storage_type), but any attempts to access a virtual drive with no media mounted will result in a "no media" error.