Route Cache Flags

If set, the OpenFile event will fire as usual when such requests arrive.

Note: This flag is implied if any of the other CBFS_ROUTE_*_EVENT flags are present.

If set, the CleanupFile event will fire as usual when such requests arrive.

If set, the CloseFile event will fire as usual when such requests arrive.

Note: This flag is implied if any of the other CBFS_ROUTE_*_EVENT flags are present.

If set, the EnumerateDirectory event will fire as usual when such requests arrive.

If set, the SetFileSecurity event will fire as usual when such requests arrive.

If set, the GetFileSecurity event will fire as usual when such requests arrive.

If set, the SetFileAttributes event will fire as usual when such requests arrive.

If set, the SetFileSize event will fire as usual when such requests arrive.

If set, the OpenFile event will fire as usual when such requests arrive.

If set, the CreateHardLink event will fire as usual when such requests arrive.

If set, the QueryQuotas event will fire as usual when such requests arrive.

If set, the SetQuotas event will fire as usual when such requests arrive.

If set, the CanFileBeDeleted event will fire as usual when such requests arrive.

If set, the IsDirectoryEmpty event will fire as usual when such requests arrive.

If set, the RenameOrMoveFile event will fire as usual when such requests arrive.

Module Flags

This module must be installed if the application wishes to make use of Plug-and-Play (PnP) storage features. PnP storage devices are those visible as disks in the Device Manager, and the system treats such storage devices differently from other purely virtual devices.

The filesystem driver must be re-installed anytime this module is added or removed.

The product's filesystem driver module provides the core of its functionality; it must be installed for the product to function correctly.

This module provides supplementary functionality; please refer to the Helper DLL topic for more information.

Note: Not applicable when calling the GetDriverStatus method.

Notify Change Flags

For directories, all handles to files in the directory are immediately closed.

For files, use this option when the file's contents have changed. For directories, use this option when there is a change in alternate data streams that belong to the directory.

If a directory is reported as modified, all handles to files in the directory are immediately invalidated.

This option is only applicable if CorrectAllocationSizes is false.

Note that using this option can cause other applications to operate using stale data if they keep the specified file or directory open, since they have no way to know about the external changes.

Install Flags

If this flag is not set (default), the installation logic will reset the driver's start type setting in the Windows registry to the default value. Setting this flag causes the installation logic to preserve the current value, which may be necessary if the user (or the application itself) set it previously.

If this flag is not set (default), the installation logic will overwrite the existing file only if the version number of the file being installed is larger than the version of the file being overwritten. Setting this flag causes the installation logic to overwrite the file even when it has the same version.

Uninstall Version Flags

Module Status Flags

Mounting Point Flags

Simple mounting points may be local or global; and when local, can be made visible in either the current user session or another one.

This flag cannot be combined with STGMP_MOUNT_MANAGER or STGMP_NETWORK, and is implied if neither of those flags are present.

When the StorageType property is set to STGT_DISK_PNP, mounting points created using the system mount manager appear as physical devices in the Disk Management snap-in of the Microsoft Management Console (mmc.exe).

This flag is a necessary prerequisite for creating a folder mounting point, which makes a drive accessible via an otherwise empty directory on another NTFS volume.

This flag cannot be combined with STGMP_SIMPLE, STGMP_NETWORK, or STGMP_LOCAL.

Only one mounting point of this type can be added to a virtual drive.

Network mounting points can be further configured using the various STGMP_NETWORK_* flags described below. Applications that plan to make use of network mounting points must be sure to install the Helper DLL before doing so, otherwise Windows Explorer will not correctly recognize the "network" drive.

This flag cannot be combined with STGMP_SIMPLE or STGMP_MOUNT_MANAGER.

This flag specifies that a local mounting point should be created rather than a global one. When this flag is set, applications must also pass an appropriate value for the AddMountingPoint method's AuthenticationId parameter.

Passing 0 for AuthenticationId will make the mounting point visible in the current user session. To make the mounting point visible in a different user session instead, pass the target session's Authentication ID.

This flag is valid when combined with STGMP_SIMPLE or STGMP_NETWORK; it cannot be combined with STGMP_MOUNT_MANAGER. Please note that a mounting point can be made available to other computers as a network share, and network shares are always globally visible on the local machine, even if this flag is set.

Such shares are only accessible when their name is already known to the accessor.

When this flag is specified, the <Server Name> part of the MountingPoint parameter value must be empty. Please refer to the Mounting Points topic for more information. This flag makes the class use the Windows API's NetShareAdd function. As per MSDN, "Only members of the Administrators, System Operators, or Power Users local group can add file shares with a call to the NetShareAdd function."

When this flag is specified, the <Server Name> part of the MountingPoint parameter value must be empty. Please refer to the Mounting Points topic for more information. This flag makes the class use the Windows API's NetShareAdd function. As per MSDN, "Only members of the Administrators, System Operators, or Power Users local group can add file shares with a call to the NetShareAdd function."

When this flag is specified, the driver handles IOCTL_REDIR_QUERY_PATH[_EX] requests by instructing the OS to direct all requests going to the <Server Name> part of the MountingPoint parameter's value to the driver instead.

This flag should be used when the <Server Name> is unique within the local system (e.g., when the application's name is used). Using this flag allows the system to avoid delays caused by certain network requests made by various processes.

When this flag is specified, the class will automatically assign a drive letter from the list of available letters. The assigned letter is added to the end of the list of mounting points, and can be retrieved from there.

Do not include a drive letter in the MountingPoint parameter's value when specifying this flag.

Desired Access Flags

File Attributes

Applications can read the file, but cannot write to it or delete it. This attribute is not honored on directories.

It is not included in an ordinary directory listing.

Applications typically use this attribute to mark files for backup or removal.

This attribute is only valid when used alone.

File systems avoid writing data back to mass storage if sufficient cache memory is available, because typically, an application deletes a temporary file after the handle is closed. In that scenario, the system can entirely avoid writing the data. Otherwise, the data is written after the handle is closed.

For a file, all of the data in the file is compressed. For a directory, compression is the default for newly created files and subdirectories.

This attribute indicates that the file data is physically moved to offline storage.

For a file, all data streams in the file are encrypted. For a directory, encryption is the default for newly created files and subdirectories.
Note: This flag is used by NTFS and the OS sends undocumented requests to the filesystem based on this flag. The flag should not be used for files in custom filesystem implementations.

Note: This flag is reserved by the OS and should not be used for files in custom filesystem implementations.

Opening the item will be more expensive than normal, e.g. it will cause at least some of it to be fetched from a remote store. This flag is reported by filesystems during directory enumerations.

File Desired Access Flags

For a directory object, the right to read the corresponding directory data.

For a directory object, the right to create a file in the directory

(For local files, write operations will not overwrite existing data if this flag is specified without FILE_WRITE_DATA.) For a directory object, the right to create a subdirectory (FILE_ADD_SUBDIRECTORY).

This access right given to scripts may cause the script to be executable, depending on the script interpreter.

This does not include the information in the SACL.

This does not include the information in the SACL.

This enables a thread to wait until the object is in the signaled state. Some object types do not support this access right.

Note: Don't match received values against this flag. Instead, use flags that specify the rights that you want to verify or add/remove.

Note: Don't match received values against this flag. Instead, use flags that specify the rights that you want to verify or add/remove.

Note: Don't match received values against this flag. Instead, use flags that specify the rights that you want to verify or add/remove.

Creation Disposition flags

If the specified file exists, the operation fails with an "already exists" error.

If the specified file exists and is writable, the system overwrites the file. If the specified file does not exist and is a valid path, a new file is created.

If the specified file does not exist, opening fails.

If the specified file exists, the operation succeeds. If the specified file does not exist and is a valid path to a writable location, the a file is created.

If the specified file does not exist, the operation fails with a "file not found" error.

Share Modes

Otherwise, other processes cannot open the file if they request read access. If this flag is not specified, but the file has been opened for read access, file creation or opening fails.

Otherwise, other processes cannot open the file if they request write access. If this flag is not specified, but the file has been opened for write access or has a file mapping with write access, file creation or opening fails.

Otherwise, other processes cannot open the file if they request delete access. If this flag is not specified, but the file has been opened for delete access, the function fails.
Note: Delete access allows both delete and rename operations.

Storage Type Values

Important: The CBFS Connect system driver must be installed in PnP mode for this option to function properly.

Storage Characteristics Flags

This flag is not supported when StorageType is set to STGT_DISK_PNP.

This flag is not supported when StorageType is set to STGT_DISK_PNP.

Users may remove the storage media from the virtual drive at any time. (Note that this flag does not indicate that the virtual drive itself is removable.)

Deprecated: Include the STGMP_AUTOCREATE_DRIVE_LETTER flag in the value passed for the AddMountingPoint method's Flags parameter instead.

When this flag is present, the StorageGUID property must be set. This flag only works when StorageType is set to STGT_DISK_PNP.

This flag only works when StorageType is set to STGT_DISK_PNP.

Users may eject the virtual drive at any time. When the virtual drive is ejected, it is destroyed.

This flag only works when StorageType is set to STGT_DISK_PNP.