Constants
All constants are accessible through the cbcconstants unit.
Causes files to be treated as read-only; all write operations will be automatically denied.
Prevents 'open' requests from being routed automatically.
If set, the OpenFile event will fire as usual when such requests arrive.
Prevents 'cleanup' requests from being routed automatically.
If set, the CleanupFile event will fire as usual when such requests arrive.
Prevents 'close' requests from being routed automatically.
If set, the CloseFile event will fire as usual when such requests arrive.
Prevents 'enumerate directory' requests from being routed automatically.
If set, the EnumerateDirectory event will fire as usual when such requests arrive.
Prevents 'set security' requests from being routed automatically.
If set, the SetFileSecurity event will fire as usual when such requests arrive.
Prevents 'get security' requests from being routed automatically.
If set, the GetFileSecurity event will fire as usual when such requests arrive.
Prevents 'set file attributes' requests from being routed automatically.
If set, the SetFileAttributes event will fire as usual when such requests arrive.
Prevents 'set file size' requests from being routed automatically.
If set, the SetFileSize event will fire as usual when such requests arrive.
Prevents 'set valid data length' requests from being routed automatically.
If set, the OpenFile event will fire as usual when such requests arrive.
Prevents 'create hard link' requests from being routed automatically.
If set, the CreateHardLink event will fire as usual when such requests arrive.
Prevents 'query quota' requests from being routed automatically.
If set, the QueryQuotas event will fire as usual when such requests arrive.
Prevents 'set quota' requests from being routed automatically.
If set, the SetQuotas event will fire as usual when such requests arrive.
Prevents 'can file be deleted' requests from being routed automatically.
If set, the CanFileBeDeleted event will fire as usual when such requests arrive.
Prevents 'is directory empty' requests from being routed automatically.
If set, the IsDirectoryEmpty event will fire as usual when such requests arrive.
Prevents 'rename/move' requests from being routed automatically.
If set, the RenameOrMoveFile event will fire as usual when such requests arrive.
Prevents 'set ea' requests from being routed automatically.
If set, the SetEa event will fire as usual when such requests arrive.
Prevents 'query ea' requests from being routed automatically.
If set, the QueryEa event will fire as usual when such requests arrive.
The specified file or directory has been created.
The specified file or directory has been removed.
For directories, all handles to files in the directory are immediately closed.
The specified file or directory has been modified.
For files, use this option when the file's contents have changed. For directories, use this option when a change is made in alternate data streams that belong to the directory.
The timestamp or other attributes of the specified file or directory have been modified.
The allocation size for the specified file or directory has been modified.
This option is applicable only if CorrectAllocationSizes is False.
The specified file or directory has been modified, but handles should not be invalidated.
Note: Using this option can cause other applications to operate using stale data if they keep the specified file or directory open, because they have no way to know about the external changes.
The specified file or directory has been renamed.
This flag updates the internally stored name and does not invalidate existing handles (if any exist).
Ignore the request if the file has locked ranges.
This supplementary flag may be used together with the CBFS_NOTIFY_FLAG_MODIFIED_NOT_INVALIDATE flag to tell the driver that if the file has locked ranges, the notification should be ignored.
Uninstall drivers and helper DLLs from previous component versions (e.g., 2017).
Note: This functionality is only available in Windows.
This flag does not remove the old PnP driver (VPnpBus) from the system because that driver is not versioned. Use the installer DLL of the old version and its Uninstall() function if you need to uninstall the PnP driver.
Keep the driver's current start type setting in the registry.
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.
Install files when their version is the same as the version of already installed files.
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 modules from previous product versions.
Uninstall modules from the current product version.
Uninstall modules from all product versions.
PnP Bus Driver (.sys file).
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.
Core Product Driver (.sys file).
The product's filesystem driver module provides the core of its functionality; it must be installed for the product to function correctly.
Shell Helper DLL (CBFSShellHelper24.dll)
This module provides supplementary functionality; please refer to the Helper DLL topic for more information.
The specified module is not present on the system.
The specified module is in the Stopped state.
The specified module is loaded and running.
Create a simple mounting point.
Simple mounting points may be local or global; and when local, can be made visible in either the current user session or another one.
Create a mounting point that appears to the system as a physical device.
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).
Create a network mounting point.
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 File Explorer will not correctly recognize the "network" drive.
Specifies that a local mounting point should be created.
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.
Indicates that users may assign a drive letter to the share (e.g., using the 'Map network drive...' context menu item in Windows File Explorer).
Indicates that the share should be skipped during enumeration.
Such shares are only accessible when their name is already known to the accessor.
Makes a read-only share available for the mounting point.
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 component 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."
Makes a read/write share available for the mounting point.
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 component 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."
Specifies that the server name is unique.
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.
Causes the method to return immediately without waiting for mounting notifications to be sent to the system.
Tells the component that it should assign the drive letter automatically.
When this flag is specified, the component 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.
Ea size is requested.
File's actual name is requested.
In an EnumerateDirectory event handler, store the name of the file or directory in the FileName parameter.
In a GetFileInfo event handler, store the name of the file or directory in the RealFileName parameter.
Refer to the corresponding event's help topic for more details.
Short name is requested.
File times are requested.
File size is requested.
File attributes are requested.
File Id is requested.
This flag is used when UseFileIds is True.
File Reparse Tag is requested.
This flag is used when UseReparsePoints is True. The reparse tag must be provided if file attributes indicate that the file or directory is a reparse point.
Grant/deny read access.
Grant/deny write access.
Grant/deny read and write access.
The file is read-only.
Applications can read the file, but cannot write to it or delete it. This attribute is not honored on directories.
The file or directory is hidden.
The file is not included in an ordinary directory listing.
A file or directory that the operating system uses a part of, or uses exclusively.
The entry is a directory.
The entry is an archive file or directory.
Applications typically use this attribute to mark files for backup or removal.
A file doesn't have other attributes set.
This attribute is valid only when used alone.
A file that is being used for temporary storage.
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 are written after the handle is closed.
A file that is a sparse file.
A file that is a reparse point or a symbolic link.
A file or directory that is compressed.
For a file, all of the data in the file are compressed. For a directory, compression is the default for newly created files and subdirectories. A filesystem implementation can make use of this attribute by setting the SupportCompressedAttribute property to True and then properly handling the GetFileInfo, EnumerateDirectory, and SetFileAttributes events.
The data of a file are not available immediately.
This attribute indicates that the file data are physically moved to offline storage.
The file or directory is not to be indexed by the content indexing service.
A file or directory that is encrypted.
For a file, all data streams in the file are encrypted. For a directory, encryption is the default for newly created files and subdirectories.
Reserved.
The file or directory has no physical representation on the local system; the item is virtual.
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.
For a directory, the right to list the contents of the directory.
For a file object, the right to read the corresponding file data.
For a directory object, the right to read the corresponding directory data.
For a directory, the right to create a file in the directory.
For a file object, the right to write data to the file.
For a directory object, the right to create a file in the directory
For a directory, the right to create a subdirectory.
For a file object, the right to append data to the file.
(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).
The right to read extended file attributes.
The right to write extended file attributes.
For a native code file, the right to execute the file.
This access right given to scripts may cause the script to be executable, depending on the script interpreter.
For a directory, the right to delete a directory and all the files it contains, including read-only files.
The right to read file attributes.
The right to write file attributes.
The right to read the information in the file or directory object's security descriptor.
This does not include the information in the SACL.
Includes READ_CONTROL, which is the right to read the information in the file or directory object's security descriptor.
This does not include the information in the SACL.
Same as STANDARD_RIGHTS_READ
Same as STANDARD_RIGHTS_READ
The right to use the object for synchronization.
This enables a thread to wait until the object is in the signaled state. Some object types do not support this access right.
All possible access rights for a file.
A combinarion of flags that allow reading of the file.
Note: Don't match received values against this flag. Instead, use flags that specify the rights that you want to verify or add/remove.
A combinarion of flags that allow modifications to the file.
Note: Don't match received values against this flag. Instead, use flags that specify the rights that you want to verify or add/remove.
A combinarion of flags that allow execution of the file.
Note: Don't match received values against this flag. Instead, use flags that specify the rights that you want to verify or add/remove.
Creates a new file, only if it does not already exist.
If the specified file exists, the operation fails with an "already exists" error.
Creates a new file, always.
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.
Opens a file, only if it exists
If the specified file does not exist, opening fails.
Opens a file, always.
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.
Opens a file and truncates it so that its size is zero bytes, only if it exists.
If the specified file does not exist, the operation fails with a "file not found" error.
Enables subsequent open operations on a file to request read access.
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.
Enables subsequent open operations on a file to request write access.
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.
Enables subsequent open operations on a file to request delete access.
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.
Create a regular disk device.
Create a CD-ROM or DVD device.
Create a plug-and-play storage device.
Important: The CBFS Connect system driver must be installed in PnP mode for this option to function properly.
The storage is a floppy disk device.
This flag is not supported when StorageType is set to STGT_DISK_PNP.
The storage is a read-only device.
The storage device's media can only be written to once.
This flag is not supported when StorageType is set to STGT_DISK_PNP.
The storage device's media is removable.
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.)
The system should automatically create a drive letter for the storage device.
Deprecated: Include the STGMP_AUTOCREATE_DRIVE_LETTER flag in the value passed for the AddMountingPoint method's Flags parameter instead.
The storage device should be shown in the 'Safely Remove Hardware and Eject Media' menu in the system notification area (system tray).
This flag only works when StorageType is set to STGT_DISK_PNP.
The storage device can be ejected.
Users may eject the virtual drive at any time. When the virtual drive is ejected, it is destroyed.
Reserved, do not use.
Reserved, do not use.
The attributes are set as a part of a file create/open operation.
The attributes are set via the SetFileAttributes or NtSetInformationFile function.
A file's Compressed state is changed using one of the *DeviceIOControl functions.
A handle to the file is being closed and its attributes are updated .
The lock owner is to be retrieved.
This command is not used in Windows. In Linux, the process identifier (PID) of the lock owner must be returned. The constant is the same as the F_GETLK constant used in Linux.
Set lock.
If the lock cannot be set immediately, return immediately with an error (EAGAIN and EACCES are recommended). The constant is the same as the F_SETLK constant used in Linux.
Set lock and wait.
If the lock cannot be set immediately, wait until this becomes possible. The constant is the same as the F_SETLKW constant used in Linux.
Read lock should be acquired.
Other applications may read from the locked range but not write to it.
The constant is the same as the F_RDLCK constant used in Linux.
Write lock should be acquired.
No other application may write to the locked range.
The constant is the same as the F_WRLCK constant used in Linux.
The lock should be released.
The constant is the same as the F_UNLCK constant used in Linux.
If the vault is damaged beyond repair, report an error.
When this flag is used, the CheckAndRepair will return an error if the vault could not be repaired.
If the vault is damaged beyond repair, recreate the vault automatically.
When this flag is used, the CheckAndRepair will delete the damaged vault and create a new one instead.
The cache is idle.
Cache cleanup is being performed.
The cache's storage file is being compacted.
The cache is reading some file's data.
The cache is writing some file's data.
Enumerate all files.
Enumerate files with changed blocks.
Enumerate files with no changed blocks.
Enumerate local files.
Refer to the Local Files topic for more information.
Enumerate orphan files.
Refer to the Orphan Files topic for more information.
Enumerate pinned files.
Retrieves the value of the Changed state of the file.
Retrieves the value of the Unchanged state of the file.
Retrieves the value that indicates whether the file is Local.
Refer to the Local Files topic for more information.
Retrieves the value that indicates whether the file is Orphan.
Refer to the Orphan Files topic for more information.
Retrieves the value of the Open state of the file.
Flush as usual, taking into account any specified delay.
The FlushAfterCloseDelay property specifies the delay.
Passing this value to FileClose or FileCloseEx will cause the method to return immediately; flushing is performed in the background. Passing this value to CloseCache has no effect (i.e., the cache is not flushed before being closed).
Do not flush anything.
Flush immediately.
Passing this value to FileClose, FileCloseEx, and CloseCache will cause the method to return only after all flushing operations are complete.
Flush file data synchronously, blocking until finished.
Flush file data in the background; do not wait until the flush operation completes.
Check to see if file data exists and needs to be flushed, but do not actually flush anything.
The file has no data that need flushing.
Data in the file need flushing, but no flush operation is running yet.
Data in the file are in the process of being flushed.
Data in the file have been flushed successfully.
Do not prefetch any file data.
Prefetch all file data.
Cache cleanup
Purge as usual, taking into account any specified delay.
The PurgeAfterCloseDelay property specifies the delay.
Passing this value to FileClose or FileCloseEx will cause the method to return immediately; purging is performed in the background. Passing this value to CloseCache has no effect; the cache is not purged before being closed.
Do not purge anything.
Purge immediately.
Passing this value to FileClose, FileCloseEx, or CloseCache will cause the method to return only after all purging operations are complete.
A file's data are being transferred into or out of the cache.
A data transfer has been canceled for some reason.
The entire file is being transferred.
A continuous transfer has started.
A continuous transfer has restarted from the beginning.
A continuous transfer is finishing (i.e., the current block is the final one).
A random-access transfer has started.
A random-access transfer is finishing (i.e., the current block is the final one).
The current transfer will finish before the end of the file.
The current transfer will last until the end of the file.
No random access allowed; read/write operations must start at the beginning of a file.
When this flag is used in writing capabilities, the component can initiate reading of missing data before writing the changes to build the complete dataset, which is required for correct write operations.
Reading/writing is possible at positions that are multiple of the corresponding block size.
The read and write block sizes are specified by the ReadBlockSize and WriteBlockSize properties .
When this flag is used in writing capabilities, the component can initiate reading of missing data before writing the changes to build the complete dataset, which is required for correct write operations.
Reading/writing is possible at any position.
When this flag is used, other flags can still alter the positions at which reading/writing are possible.
File position must remain in the range: 0 <= FilePos < FileSize
Only whole-file reads/writes are possible; partial reads/writes are not supported.
Note:
Reads/writes must be done in blocks of a fixed size, except for the last block, which may be of any size.
When this flag is used in writing capabilities, the component can initiate reading of missing data before writing the changes to build the complete dataset, which is required for correct write operations.
Reads/writes must be done in blocks of a fixed size, including the last block.
Note: Real file sizes, if needed, must be stored elsewhere when using the cache with an external storage medium that has this characteristic.
Reads/writes may be done in blocks of any size.
Append only; write operations must start at the end of a file.
To overwrite a file, it must first be truncated, and then written to. (Truncation behavior is defined by the corresponding flags.)
File position remain in the range: 0 <= FilePos <= FileSize
When writing, appending to the end of the file is supported, but writing at positions past the end of the file is not.
When writes occur, the last data written becomes the new end of the file.
Any overwritten data, and any data previously present after the written range, are lost.
Normal writing behavior (i.e., writes do not alter a file's size, except possibly to expand it).
Writes may not extend past the end of a file's current size (i.e., cannot cause a file to grow).
Applications may still adjust the file size beforehand.
Files can grow to any size.
Files can shrink to any size.
Files can grow to sizes that are a multiple of the block size.
Files can shrink to sizes that are a multiple of the block size.
The external storage (or application itself) supports truncating a file when it is opened for writing.
The external storage (or application itself) supports truncating a file to zero at any time (not just when it is being opened).
Success.
Returning this code indicates that all data were successfully transferred.
Partial success.
Returning this code indicates that some, but not all, data were successfully transferred.
i.e., when BytesRead < BytesToRead (for ReadData),
or BytesWritten < BytesToWrite (for WriteData).
Specified range is beyond the end of the file (EOF).
For the ReadData event, returning this code indicates to the cache that there is no need to request data beyond (Position + BytesRead), and that the tail should be zeroed instead.
The specified file's size was modified externally.
Returning this code indicates that the operation was not completed successfully because of this conflicting situation.
The requested file's size was modified locally.
The operation failed for some transient reason.
Returning this code indicates that, even though the current request failed, it is safe to continue sending requests for both the specified file and others.
(Other operations may continue.)
The operation failed for some external-file-related reason.
Returning this code indicates that some failure related to the external file has occurred, and it is expected that any further requests made against that file will also fail. The component will not send any more requests for the specified file until the file-specific error is reset as described in Reporting Transfer Errors.
The operation failed for some external-storage-related reason.
Returning this code indicates that some failure related to the external storage has occurred, and it is expected that all further requests will also fail. The component will not send any more requests for any file until the global error is reset as described in Reporting Transfer Errors.
Read data from a file or read a directory.
Look up a name in a directory (no meaning for non-directory objects).
Rewrite existing file data or modify existing directory entries.
Write new data or add directory entries.
Delete an existing directory entry.
Execute a file (no meaning for a directory).
Indicates the file should be opened if it exists, but if the file does not exist, the file should not be created. In this case, the operation should fail with the error NFS4ERR_NOENT.
Indicates the file should be created using the method specified by the CreateMode parameter.
Indicates the file should be created without checking for the existence of a duplicate file in the associated directory.
Indicates the file should be created, but the server should check for the presence of a duplicate file before doing so. If the file exists, the open operation should fail with the error NFS4ERR_EXIST.
Indicates the file should be exclusively created, or created with the condition that no other client should be concurrently creating or opening a file with the same name. If a file with the same name does exist, the operation should fail with the error NFS4ERR_EXIST.
Indicates the client desires read-only access to the file.
Indicates the client desires write-only access to the file.
Indicates the client desires both read and write access to the file.
Indicates no denial of share access to other clients while the file is open.
Indicates denial of read access to other clients while the file is open.
Indicates denial of write access to other clients while the file is open.
Indicates denial of both read and write access to other clients while the file is open.
Indicates a non-blocking read lock.
Indicates a non-blocking write lock.
Indicates a blocking read lock.
Indicates a blocking write lock.
Indicates the application is free to commit any part of the data written and filesystem metadata before returning any results.
Indicates the application must commit all of the data to stable storage and enough filesystem metadata to retrieve the data before returning any results.
Indicates the application must commit the data written plus all filesystem metadata to stable storage before returning any results.
Indicates successful completion of the operation, in that all constituent operations completed without error.
Indicates that permission has been denied. The client does not have the correct permission to perform the requested operation.
Note this differs from NFS4ERR_PERM which is constrained to owner or privileged user permission failures.
A locking state of any type has been revoked due to administrative interaction, possibly while the lease is valid, or because a delegation was revoked because of failure to return it, while the lease was valid.
An attribute specified by the client is not supported by the server. This error must not be returned in the GetAttr event.
A UTF-8 string contains a character that is not supported by the server in the context in which it is being used.
A name string in a request consisted of valid UTF-8 characters supported by the server, but the name is not supported by the server as a valid name for current operation.
An example might be creating a file or directory named ".." on a server whose file system uses that name for links to parent directories.
This error should not be returned due to a normalization issue in a string.
When a file system keeps names in a particular normalization form, it is the server's responsibility to do the appropriate normalization, rather than rejecting the name.
This error is returned when an owner or owner_group attribute value cannot be translated to a local representation.
An attempt was made to create an object with an inappropriate type specified.
This error should be returned if the client provides an invalid or unusable cookie in the ReadDir event.
The range specified in the Lock event is not appropriate to the allowable range of offsets for the server.
For example, this error results when a server that only supports 32-bit ranges receives a range that cannot be handled by that server.
The server has been able to determine a file locking deadlock condition for a blocking lock request.
For some reason, the application could not process this operation in what was deemed a reasonable time.
An attempt to lock a file is denied. Note this may be a temporary condition.
Either the resource (quota) hard limit has been exceeded for the server, or the client's resource limit on the server has been exceeded.
A file system object of the specified target name already exists. Applicable when creating or renaming a file during the Open or Rename operations.
This error indicates a locking state of any type has been revoked or released due to cancellation of the client's lease, either immediately upon lease expiration, or following a later request for a conflicting lock.
The file system object is too large. The operation would have caused a file system object to grow beyond the server's limit.
The operation is not allowed because a file system object involved in the operation is currently open. Servers may disallow removing or renaming open file system objects.
The server is in its recovery or grace period, which should at least match the lease period of the server. A locking request other than a reclaim could not be granted during that period.
The arguments for this operation are determined to be invalid by the application.
This indicates an unrecoverable I/O error has occurred for the file system.
The current object designates a directory when the current operation does not allow a directory to be accepted as the target of this operation.
A lease being renewed is associated with a file system that has been migrated to a new server.
A READ or WRITE operation was attempted on a file where there was a conflict between the I/O and an existing lock.
A conflict may occur if a) there is a share reservation inconsistent with the I/O being done, or b) the range to be read or written intersects an existing mandatory byte-range lock.
An operation was prevented due to the existence of a lock on the target object.
A locking request was attempted that would require the upgrade or downgrade of a lock range already held by the owner when the server does not support atomic upgrade or downgrade of locks.
A lock request is operating on a range that partially overlaps a currently held lock for the current lock-owner and does not precisely match a single such lock, where the server does not support this type of request and thus does not implement POSIX locking semantics.
The request would have caused the server's limit for the number of hard links a file system object may have to be exceeded.
This is returned when the filename in an operation exceeds the server's implementation limit.
This indicates no such file or directory. The file system object referenced by the name specified does not exist.
This indicates no space left on the device. The operation would have caused the server's file system to exceed its limit.
Indicates that the current object is not a directory for an operation in which a directory is required.
An attempt was made to remove a directory that was not empty.
The operation is not supported, either because the operation is an optional one and is not supported by this server or because the operation must not be implemented in the current minor version.
The server cannot guarantee that it has not granted state to another client that may conflict with this client's state. No further reclaims from this client will succeed.
The client attempted a Read, Write, Lock, or other operation not available to the client (e.g., writing to a file opened only for read).
This indicates that the requester is not the owner. The operation was not allowed because the caller is neither a privileged user nor the owner of the target of the operation.
The server cannot guarantee that it has not granted state to another client that may conflict with the requested state. However, this applies only to the state requested in this call; further reclaims may succeed.
This result code is only valid for Lock and Open operations.
The reclaim attempted by the client conflicts with a lock already held by another client. Unlike NFS4ERR_RECLAIM_BAD, this can only occur if one of the clients misbehaved.
This result code is only valid for Lock and Open operations.
This indicates a read-only file system. A modifying operation was attempted on a read-only file system.
An error that does not map to any of the specific legal NFSv4 protocol error values occurred on the server.
An attempt to open a file with a share reservation has failed due to an existing share conflict.
The current object designates a symbolic link when the current operation does not allow a symbolic link as the target.
This error is used where an operation returns a variable amount of data, with a limit specified by the client. Where the data returned cannot be fitted within the limit specified by the client, this error results.
This indicates an attempt to perform an operation, such as linking, has inappropriately crossed a boundary (e.g., across a file system boundary).
Route Cache Flags
CBFS_ROUTE_FILE_READ_ONLY
Value: 0x00000001
CBFS_ROUTE_OPEN_EVENT
Value: 0x00000020
Note: This flag is implied if any of the other CBFS_ROUTE_*_EVENT flags are present.
CBFS_ROUTE_CLEANUP_EVENT
Value: 0x00000040
CBFS_ROUTE_CLOSE_EVENT
Value: 0x00000080
Note: This flag is implied if any of the other CBFS_ROUTE_*_EVENT flags are present.
CBFS_ROUTE_ENUMERATE_DIRECTORY_EVENT
Value: 0x00000200
CBFS_ROUTE_SET_SECURITY_EVENT
Value: 0x00000400
CBFS_ROUTE_GET_SECURITY_EVENT
Value: 0x00000800
CBFS_ROUTE_SET_FILE_ATTRIBUTES_EVENT
Value: 0x00002000
CBFS_ROUTE_SET_FILE_SIZES_EVENT
Value: 0x00004000
CBFS_ROUTE_SET_VALID_DATA_LENGTH_EVENT
Value: 0x00008000
CBFS_ROUTE_CREATE_HARD_LINK_EVENT
Value: 0x00020000
CBFS_ROUTE_QUERY_QUOTA_EVENT
Value: 0x00040000
CBFS_ROUTE_SET_QUOTA_EVENT
Value: 0x00080000
CBFS_ROUTE_CAN_FILE_BE_DELETED_EVENT
Value: 0x00200000
CBFS_ROUTE_IS_DIRECTORY_EMPTY_EVENT
Value: 0x00400000
CBFS_ROUTE_RENAME_EVENT
Value: 0x00800000
CBFS_ROUTE_SET_EA_EVENT
Value: 0x01000000
CBFS_ROUTE_QUERY_EA_EVENT
Value: 0x02000000
Notify Change Flags
CBFS_NOTIFY_FLAG_ADDED
Value: 0x00000001
CBFS_NOTIFY_FLAG_REMOVED
Value: 0x00000002
CBFS_NOTIFY_FLAG_MODIFIED
Value: 0x00000003
If a directory is reported as modified, all handles to files in the directory are immediately invalidated.
CBFS_NOTIFY_FLAG_METADATA_MODIFIED
Value: 0x00000004
CBFS_NOTIFY_FLAG_ALLOCATION_SIZE_MODIFIED
Value: 0x00000005
CBFS_NOTIFY_FLAG_MODIFIED_NOT_INVALIDATE
Value: 0x00000006
CBFS_NOTIFY_FLAG_RENAMED
Value: 0x00000007
CBFS_NOTIFY_FLAG_SKIP_LOCKED_FILE
Value: 0x00001000
Install Flags
INSTALL_REMOVE_OLD_VERSIONS
Value: 0x00000001
INSTALL_KEEP_START_TYPE
Value: 0x00000002
Note: This functionality is only available in Windows.
INSTALL_OVERWRITE_SAME_VERSION
Value: 0x00000004
Note: This functionality is only available in Windows.
Uninstall Version Flags
UNINSTALL_VERSION_PREVIOUS
Value: 0x00000001
Note: This functionality is only available in Windows.
UNINSTALL_VERSION_CURRENT
Value: 0x00000002
Note: This functionality is only available in Windows.
UNINSTALL_VERSION_ALL
Value: 0x00000003
Note: This functionality is only available in Windows.
Module Flags
MODULE_PNP_BUS
Value: 0x00000001
The filesystem driver must be reinstalled any time this module is added or removed.
MODULE_DRIVER
Value: 0x00000002
MODULE_HELPER_DLL
Value: 0x00010000
Note: This module is not applicable when calling the GetDriverStatus method.
Module Status Flags
MODULE_STATUS_NOT_PRESENT
Value: 0x00000000
Note: This functionality is only available in Windows.
MODULE_STATUS_STOPPED
Value: 0x00000001
Note: This functionality is only available in Windows.
MODULE_STATUS_RUNNING
Value: 0x00000004
Note: This functionality is only available in Windows.
Mounting Point Flags in Windows
STGMP_SIMPLE
Value: 0x00010000
This flag cannot be combined with STGMP_MOUNT_MANAGER or STGMP_NETWORK, and is implied if neither of those flags are present.
STGMP_MOUNT_MANAGER
Value: 0x00020000
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.
An application cannot add a STGMP_MOUNT_MANAGER mounting point for a virtual drive created in a Docker container.
STGMP_NETWORK
Value: 0x00040000
This flag cannot be combined with STGMP_SIMPLE or STGMP_MOUNT_MANAGER.
When a virtual drive is created in a Docker container by an application running on the host, it cannot add a mounting point of STGMP_NETWORK type. If an application is running in the container, STGMP_NETWORK type may be used.
STGMP_LOCAL
Value: 0x10000000
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.
STGMP_NETWORK_ALLOW_MAP_AS_DRIVE
Value: 0x00000001
STGMP_NETWORK_HIDDEN_SHARE
Value: 0x00000002
STGMP_NETWORK_READ_ACCESS
Value: 0x00000004
STGMP_NETWORK_WRITE_ACCESS
Value: 0x00000008
STGMP_NETWORK_CLAIM_SERVER_NAME
Value: 0x00000010
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.
This flag is also required for "net view" command to be able to show the share in the list.STGMP_DRIVE_LETTER_NOTIFY_ASYNC
Value: 0x20000000
STGMP_AUTOCREATE_DRIVE_LETTER
Value: 0x40000000
Do not include a drive letter in the MountingPoint parameter's value when specifying this flag.
RequestedInfo Flags
FILEINFO_EA_SIZE
Value: 0x0400
FILEINFO_REAL_NAME
Value: 0x0040
FILEINFO_SHORT_NAME
Value: 0x0200
FILEINFO_TIME
Value: 0x0004
FILEINFO_SIZE
Value: 0x0008
FILEINFO_ATTR
Value: 0x0010
FILEINFO_FILEID
Value: 0x0020
FILEINFO_REPARSE_TAG
Value: 0x0080
Desired Access Flags
STG_DACCESS_READ
Value: 0x00000001
STG_DACCESS_WRITE
Value: 0x00000002
STG_DACCESS_READWRITE
Value: 0x00000003
File Attributes
FILE_SYS_ATTR_READ_ONLY
Value: 0x00000001
FILE_SYS_ATTR_HIDDEN
Value: 0x00000002
FILE_SYS_ATTR_SYSTEM
Value: 0x00000004
FILE_SYS_ATTR_DIRECTORY
Value: 0x00000010
FILE_SYS_ATTR_ARCHIVE
Value: 0x00000020
FILE_SYS_ATTR_NORMAL
Value: 0x00000080
FILE_SYS_ATTR_TEMPORARY
Value: 0x00000100
FILE_SYS_ATTR_SPARSE_FILE
Value: 0x00000200
FILE_SYS_ATTR_REPARSE_POINT
Value: 0x00000400
FILE_SYS_ATTR_COMPRESSED
Value: 0x00000800
FILE_SYS_ATTR_OFFLINE
Value: 0x00001000
FILE_SYS_ATTR_NOT_CONTENT_INDEXED
Value: 0x00002000
FILE_SYS_ATTR_ENCRYPTED
Value: 0x00004000
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.
FILE_SYS_ATTR_VIRTUAL
Value: 0x00010000
Note: This flag is reserved by the OS and should not be used for files in custom filesystem implementations.
FILE_SYS_ATTR_RECALL_ON_OPEN
Value: 0x00040000
File Desired Access Flags
DESIRED_ACCESS_FILE_LIST_DIRECTORY
Value: 0x00000001
DESIRED_ACCESS_FILE_READ_DATA
Value: 0x00000001
DESIRED_ACCESS_FILE_ADD_FILE
Value: 0x00000002
DESIRED_ACCESS_FILE_WRITE_DATA
Value: 0x00000002
DESIRED_ACCESS_FILE_ADD_SUBDIRECTORY
Value: 0x00000004
DESIRED_ACCESS_FILE_APPEND_DATA
Value: 0x00000004
DESIRED_ACCESS_FILE_READ_EA
Value: 0x00000008
DESIRED_ACCESS_FILE_WRITE_EA
Value: 0x00000010
DESIRED_ACCESS_FILE_EXECUTE
Value: 0x00000020
DESIRED_ACCESS_FILE_DELETE_CHILD
Value: 0x00000040
DESIRED_ACCESS_FILE_READ_ATTRIBUTES
Value: 0x00000080
DESIRED_ACCESS_FILE_WRITE_ATTRIBUTES
Value: 0x00000100
DESIRED_ACCESS_READ_CONTROL
Value: 0x00020000
DESIRED_ACCESS_STANDARD_RIGHTS_READ
Value: 0x00020000
DESIRED_ACCESS_STANDARD_RIGHTS_WRITE
Value: 0x00020000
DESIRED_ACCESS_STANDARD_RIGHTS_EXECUTE
Value: 0x00020000
DESIRED_ACCESS_SYNCHRONIZE
Value: 0x00100000
DESIRED_ACCESS_FILE_ALL_ACCESS
Value: 0x001F01FF
DESIRED_ACCESS_FILE_GENERIC_READ
Value: 0x00120089
DESIRED_ACCESS_FILE_GENERIC_WRITE
Value: 0x00120116
DESIRED_ACCESS_FILE_GENERIC_EXECUTE
Value: 0x001200A0
Creation Disposition flags
FILE_DISPOSITION_CREATE_NEW
Value: 0x00000001
FILE_DISPOSITION_CREATE_ALWAYS
Value: 0x00000002
FILE_DISPOSITION_OPEN_EXISTING
Value: 0x00000003
FILE_DISPOSITION_OPEN_ALWAYS
Value: 0x00000004
FILE_DISPOSITION_TRUNCATE_EXISTING
Value: 0x00000005
Share Modes
FILE_SYS_SHARE_READ
Value: 0x00000001
FILE_SYS_SHARE_WRITE
Value: 0x00000002
FILE_SYS_SHARE_DELETE
Value: 0x00000004
Note: Delete access allows both delete and rename operations.
Storage Type Values
STGT_DISK
Value: 0x00000000
STGT_CDROM
Value: 0x00000001
STGT_DISK_PNP
Value: 0x00000003
Storage Characteristics Flags
STGC_FLOPPY_DISKETTE
Value: 0x00000001
STGC_READONLY_DEVICE
Value: 0x00000002
STGC_WRITE_ONCE_MEDIA
Value: 0x00000008
STGC_REMOVABLE_MEDIA
Value: 0x00000010
STGC_AUTOCREATE_DRIVE_LETTER
Value: 0x00002000
When this flag is present, the StorageGUID property must be set. This flag only works when StorageType is set to STGT_DISK_PNP.
STGC_SHOW_IN_EJECTION_TRAY
Value: 0x00004000
STGC_ALLOW_EJECTION
Value: 0x00008000
This flag only works when StorageType is set to STGT_DISK_PNP.
STGC_RESERVED_1
Value: 0x00010000
STGC_RESERVED_2
Value: 0x00020000
SetFileAttributes event origins
SETFA_ORIGIN_CREATE_FILE
Value: 0x0000
SETFA_ORIGIN_SET_INFORMATION
Value: 0x0006
SETFA_ORIGIN_FSCTL
Value: 0x000d
SETFA_ORIGIN_CLEANUP
Value: 0x0012
Possible Lock operation commands
FUSE_GETLK
Value: 0x0005
FUSE_SETLK
Value: 0x0006
FUSE_SETLKW
Value: 0x0007
Possible Lock operation types
FUSE_RDLCK
Value: 0x0000
FUSE_WRLCK
Value: 0x0001
FUSE_UNLCK
Value: 0x0002
Cache Check and Repair Flags
CACHE_CHECK_NO_RECREATE_VAULT
Value: 0x00000000
CACHE_CHECK_RECREATE_VAULT
Value: 0x00000001
Cache Cache Operation
CACHE_OP_IDLE
Value: 0
CACHE_OP_CLEANUP
Value: 2
CACHE_OP_COMPACT
Value: 3
CACHE_OP_READ
Value: 4
CACHE_OP_WRITE
Value: 5
CBCache Enumeration Mode
ENUM_MODE_ALL
Value: 0
ENUM_MODE_CHANGED
Value: 1
ENUM_MODE_UNCHANGED
Value: 2
ENUM_MODE_LOCAL
Value: 4
ENUM_MODE_ORPHAN
Value: 8
ENUM_MODE_PINNED
Value: 16
Cache File Status Kind
FILE_STATUS_CHANGED
Value: 1
FILE_STATUS_UNCHANGED
Value: 2
FILE_STATUS_LOCAL
Value: 3
FILE_STATUS_ORPHAN
Value: 4
FILE_STATUS_OPEN
Value: 5
Cache Flush Action
FLUSH_DELAYED
Value: 0
FLUSH_NONE
Value: 1
FLUSH_IMMEDIATE
Value: 2
Cache File Flushing Mode
FLUSH_MODE_SYNC
Value: 0
FLUSH_MODE_ASYNC
Value: 1
FLUSH_MODE_TEST
Value: 2
Cache Flushing Result
FLUSH_RESULT_NOTHING
Value: 0
FLUSH_RESULT_DIRTY
Value: 1
FLUSH_RESULT_RUNNING
Value: 2
FLUSH_RESULT_SUCCESS
Value: 3
Cache Prefetch Constants
PREFETCH_NOTHING
Value: 0
PREFETCH_ALL
Value: -1
Cache Progress Operations
CACHE_PO_CLEANUP
Value: 1
Cache Purge Action
PURGE_DELAYED
Value: 0
PURGE_NONE
Value: 1
PURGE_IMMEDIATE
Value: 2
ReadData/WriteData Event Flags
RWEVENT_IN_PROGRESS
Value: 0x00000001
RWEVENT_CANCELED
Value: 0x00000002
RWEVENT_WHOLE_FILE
Value: 0x00000004
RWEVENT_CONTINUOUS_STARTED
Value: 0x00000010
RWEVENT_CONTINUOUS_RESTARTED
Value: 0x00000020
RWEVENT_CONTINUOUS_FINISHED
Value: 0x00000040
RWEVENT_RANDOM_STARTED
Value: 0x00000100
RWEVENT_RANDOM_FINISHED
Value: 0x00000200
RWEVENT_BEFORE_END
Value: 0x00001000
RWEVENT_TIL_END
Value: 0x00002000
Reading and Writing Capability Flags (Position Related)
RWCAP_POS_SEQUENTIAL_FROM_BOF
Value: 0x00000001
RWCAP_POS_BLOCK_MULTIPLE
Value: 0x00000004
RWCAP_POS_RANDOM
Value: 0x00000008
RWCAP_POS_SUPPL_ONLY_WITHIN_FILE
Value: 0x00000010
Reading and Writing Capability Flags (Size Related)
RWCAP_SIZE_WHOLE_FILE
Value: 0x00000100
- The ReadBlockSize and WriteBlockSize properties should still be set to reasonable values when using this flag.
- Use one of the other RWCAP_SIZE_* flags instead of this one if the external storage supports reading subsets of the file.
RWCAP_SIZE_FIXED_BLOCKS_WITH_TAIL
Value: 0x00000200
RWCAP_SIZE_FIXED_BLOCKS_NO_TAIL
Value: 0x00000400
When this flag is used in writing capabilities, the component can initiate reading of missing data before writing the changes to build the complete dataset, which is required for correct write operations.
RWCAP_SIZE_ANY
Value: 0x00000800
Reading and Writing Capability Flags (Write Related)
RWCAP_WRITE_APPEND_ONLY
Value: 0x00000002
RWCAP_WRITE_SUPPL_NOT_BEYOND_EOF
Value: 0x00000020
RWCAP_WRITE_TRUNCATES_FILE
Value: 0x00001000
RWCAP_WRITE_KEEPS_FILESIZE
Value: 0x00002000
RWCAP_WRITE_NOT_BEYOND_EOF
Value: 0x00004000
Resizing Capability Flags
RSZCAP_GROW_TO_ANY
Value: 0x00000001
RSZCAP_SHRINK_TO_ANY
Value: 0x00000002
RSZCAP_GROW_TO_BLOCK_MULTIPLE
Value: 0x00000004
RSZCAP_SHRINK_TO_BLOCK_MULTIPLE
Value: 0x00000008
RSZCAP_TRUNCATE_ON_OPEN
Value: 0x00000010
RSZCAP_TRUNCATE_AT_ZERO
Value: 0x00000020
ReadData/WriteData Event Result Codes
RWRESULT_SUCCESS
Value: 0x00000000
RWRESULT_PARTIAL
Value: 0x00000080
RWRESULT_RANGE_BEYOND_EOF
Value: 0x00000081
RWRESULT_FILE_MODIFIED_EXTERNALLY
Value: 0x00000082
RWRESULT_FILE_MODIFIED_LOCALLY
Value: 0x00000083
RWRESULT_FAILURE
Value: 0x0000008D
RWRESULT_FILE_FAILURE
Value: 0x0000008E
RWRESULT_PERMANENT_FAILURE
Value: 0x0000008F
NFS Access Flags
ACCESS4_READ
Value: 0x00000001
ACCESS4_LOOKUP
Value: 0x00000002
ACCESS4_MODIFY
Value: 0x00000004
ACCESS4_EXTEND
Value: 0x00000008
ACCESS4_DELETE
Value: 0x00000010
ACCESS4_EXECUTE
Value: 0x00000020
NFS Open Type Constants
OPEN4_NOCREATE
Value: 0
OPEN4_CREATE
Value: 1
NFS Create Mode Constants
UNCHECKED4
Value: 0
GUARDED4
Value: 1
EXCLUSIVE4
Value: 2
NFS Share Access Flags
OPEN4_SHARE_ACCESS_READ
Value: 0x00000001
OPEN4_SHARE_ACCESS_WRITE
Value: 0x00000002
OPEN4_SHARE_ACCESS_BOTH
Value: 0x00000003
NFS Share Deny Flags
OPEN4_SHARE_DENY_NONE
Value: 0x00000000
OPEN4_SHARE_DENY_READ
Value: 0x00000001
OPEN4_SHARE_DENY_WRITE
Value: 0x00000002
OPEN4_SHARE_DENY_BOTH
Value: 0x00000003
NFS Lock Type Constants
READ_LT
Value: 1
WRITE_LT
Value: 2
READW_LT
Value: 3
WRITEW_LT
Value: 4
NFS Stable Constants
UNSTABLE4
Value: 0
DATA_SYNC4
Value: 1
FILE_SYNC4
Value: 2
NFS Result Codes
NFS4_OK
Value: 0
NFS4ERR_ACCESS
Value: 13
NFS4ERR_ADMIN_REVOKED
Value: 10047
NFS4ERR_ATTRNOTSUPP
Value: 10032
NFS4ERR_BADCHAR
Value: 10040
NFS4ERR_BADNAME
Value: 10041
NFS4ERR_BADOWNER
Value: 10039
NFS4ERR_BADTYPE
Value: 10007
NFS4ERR_BAD_COOKIE
Value: 10003
NFS4ERR_BAD_RANGE
Value: 10042
NFS4ERR_DEADLOCK
Value: 10045
NFS4ERR_DELAY
Value: 10008
NFS4ERR_DENIED
Value: 10010
NFS4ERR_DQUOT
Value: 69
NFS4ERR_EXIST
Value: 17
NFS4ERR_EXPIRED
Value: 10011
NFS4ERR_FBIG
Value: 27
NFS4ERR_FILE_OPEN
Value: 10046
NFS4ERR_GRACE
Value: 10013
NFS4ERR_INVAL
Value: 22
NFS4ERR_IO
Value: 5
NFS4ERR_ISDIR
Value: 21
NFS4ERR_LEASE_MOVED
Value: 10031
NFS4ERR_LOCKED
Value: 10012
NFS4ERR_LOCKS_HELD
Value: 10037
NFS4ERR_LOCK_NOTSUPP
Value: 10043
NFS4ERR_LOCK_RANGE
Value: 10028
NFS4ERR_MLINK
Value: 31
NFS4ERR_NAMETOOLONG
Value: 63
NFS4ERR_NOENT
Value: 2
NFS4ERR_NOSPC
Value: 28
NFS4ERR_NOTDIR
Value: 20
NFS4ERR_NOTEMPTY
Value: 66
NFS4ERR_NOTSUPP
Value: 10004
NFS4ERR_NO_GRACE
Value: 10033
NFS4ERR_OPENMODE
Value: 10038
NFS4ERR_PERM
Value: 1
NFS4ERR_RECLAIM_BAD
Value: 10034
NFS4ERR_RECLAIM_CONFLICT
Value: 10035
NFS4ERR_ROFS
Value: 30
NFS4ERR_SERVERFAULT
Value: 10006
NFS4ERR_SHARE_DENIED
Value: 10015
NFS4ERR_SYMLINK
Value: 10029
NFS4ERR_TOOSMALL
Value: 10005
NFS4ERR_XDEV
Value: 18