Changeset 78321 in vbox for trunk/src/VBox/Additions/WINNT/SharedFolders/driver/vbsfshared.h

Timestamp:

Apr 26, 2019 12:39:27 PM (6 years ago)

Author:

vboxsync

Message:

winnt/vboxsf: Doxygen and related cleanups; eliminating the separate helper header. bugref:9172

File:

• trunk/src/VBox/Additions/WINNT/SharedFolders/driver/vbsfshared.h (modified) (2 diffs)

trunk/src/VBox/Additions/WINNT/SharedFolders/driver/vbsfshared.h

@@ -1 +1 @@
 /* $Id$ */
 /** @file
- *
- * VirtualBox Windows Guest Shared Folders
- *
- * File System Driver header file shared with the network provider dll
+ * VirtualBox Windows Guest Shared Folders FSD - Definitions shared with the network provider dll.
  */
 
@@ -25 +22 @@
 #endif
 
-/* The network provider name for shared folders. */
-#define MRX_VBOX_PROVIDER_NAME_U L"VirtualBox Shared Folders"
+/** The network provider name for shared folders. */
+#define MRX_VBOX_PROVIDER_NAME_U                L"VirtualBox Shared Folders"
 
-/* The filesystem name for shared folders. */
-#define MRX_VBOX_FILESYS_NAME_U L"VBoxSharedFolderFS"
+/** The filesystem name for shared folders. */
+#define MRX_VBOX_FILESYS_NAME_U                 L"VBoxSharedFolderFS"
 
-/* The redirector device name. */
-#define DD_MRX_VBOX_FS_DEVICE_NAME_U L"\\Device\\VBoxMiniRdr"
+/** The redirector device name. */
+#define DD_MRX_VBOX_FS_DEVICE_NAME_U            L"\\Device\\VBoxMiniRdr"
 
-#define VBOX_VOLNAME_PREFIX     L"VBOX_"
-#define VBOX_VOLNAME_PREFIX_SIZE  (sizeof(VBOX_VOLNAME_PREFIX) - sizeof(VBOX_VOLNAME_PREFIX[0]))
+/** Volume label prefix. */
+#define VBOX_VOLNAME_PREFIX                     L"VBOX_"
+/** Size of volume label prefix. */
+#define VBOX_VOLNAME_PREFIX_SIZE                (sizeof(VBOX_VOLNAME_PREFIX) - sizeof(VBOX_VOLNAME_PREFIX[0]))
 
-/* Name of symbolic link, which is used by the user mode dll to open the driver. */
-#define DD_MRX_VBOX_USERMODE_SHADOW_DEV_NAME_U     L"\\??\\VBoxMiniRdrDN"
-#define DD_MRX_VBOX_USERMODE_DEV_NAME_U            L"\\\\.\\VBoxMiniRdrDN"
+/** NT path of the symbolic link, which is used by the user mode dll to
+ * open the FSD. */
+#define DD_MRX_VBOX_USERMODE_SHADOW_DEV_NAME_U  L"\\??\\VBoxMiniRdrDN"
+/** Win32 path of the symbolic link, which is used by the user mode dll
+ * to open the FSD. */
+#define DD_MRX_VBOX_USERMODE_DEV_NAME_U         L"\\\\.\\VBoxMiniRdrDN"
 
-#define IOCTL_MRX_VBOX_BASE FILE_DEVICE_NETWORK_FILE_SYSTEM
-
-#define _MRX_VBOX_CONTROL_CODE(request, method, access) \
-                CTL_CODE(IOCTL_MRX_VBOX_BASE, request, method, access)
-
-/* VBoxSF IOCTL codes. */
-#define IOCTL_MRX_VBOX_ADDCONN       _MRX_VBOX_CONTROL_CODE(100, METHOD_BUFFERED, FILE_ANY_ACCESS)
-#define IOCTL_MRX_VBOX_GETCONN       _MRX_VBOX_CONTROL_CODE(101, METHOD_BUFFERED, FILE_ANY_ACCESS)
-#define IOCTL_MRX_VBOX_DELCONN       _MRX_VBOX_CONTROL_CODE(102, METHOD_BUFFERED, FILE_ANY_ACCESS)
-#define IOCTL_MRX_VBOX_GETLIST       _MRX_VBOX_CONTROL_CODE(103, METHOD_BUFFERED, FILE_ANY_ACCESS)
-#define IOCTL_MRX_VBOX_GETGLOBALLIST _MRX_VBOX_CONTROL_CODE(104, METHOD_BUFFERED, FILE_ANY_ACCESS)
-#define IOCTL_MRX_VBOX_GETGLOBALCONN _MRX_VBOX_CONTROL_CODE(105, METHOD_BUFFERED, FILE_ANY_ACCESS)
-#define IOCTL_MRX_VBOX_START         _MRX_VBOX_CONTROL_CODE(106, METHOD_BUFFERED, FILE_ANY_ACCESS)
-#define IOCTL_MRX_VBOX_STOP          _MRX_VBOX_CONTROL_CODE(107, METHOD_BUFFERED, FILE_ANY_ACCESS)
+/** @name IOCTL_MRX_VBOX_XXX - VBoxSF IOCTL codes.
+ * @{  */
+#define IOCTL_MRX_VBOX_ADDCONN          CTL_CODE(FILE_DEVICE_NETWORK_FILE_SYSTEM, 100, METHOD_BUFFERED, FILE_ANY_ACCESS)
+#define IOCTL_MRX_VBOX_GETCONN          CTL_CODE(FILE_DEVICE_NETWORK_FILE_SYSTEM, 101, METHOD_BUFFERED, FILE_ANY_ACCESS)
+#define IOCTL_MRX_VBOX_DELCONN          CTL_CODE(FILE_DEVICE_NETWORK_FILE_SYSTEM, 102, METHOD_BUFFERED, FILE_ANY_ACCESS)
+#define IOCTL_MRX_VBOX_GETLIST          CTL_CODE(FILE_DEVICE_NETWORK_FILE_SYSTEM, 103, METHOD_BUFFERED, FILE_ANY_ACCESS)
+#define IOCTL_MRX_VBOX_GETGLOBALLIST    CTL_CODE(FILE_DEVICE_NETWORK_FILE_SYSTEM, 104, METHOD_BUFFERED, FILE_ANY_ACCESS)
+#define IOCTL_MRX_VBOX_GETGLOBALCONN    CTL_CODE(FILE_DEVICE_NETWORK_FILE_SYSTEM, 105, METHOD_BUFFERED, FILE_ANY_ACCESS)
+#define IOCTL_MRX_VBOX_START            CTL_CODE(FILE_DEVICE_NETWORK_FILE_SYSTEM, 106, METHOD_BUFFERED, FILE_ANY_ACCESS)
+#define IOCTL_MRX_VBOX_STOP             CTL_CODE(FILE_DEVICE_NETWORK_FILE_SYSTEM, 107, METHOD_BUFFERED, FILE_ANY_ACCESS)
+/** @} */
 
 #endif /* !GA_INCLUDED_SRC_WINNT_SharedFolders_driver_vbsfshared_h */