VirtualBox

Changeset 75383 in vbox


Ignore:
Timestamp:
Nov 10, 2018 1:44:06 AM (6 years ago)
Author:
vboxsync
Message:

shflsvc.h: Doxygen. Removed the unused SHFLL_MF_SYSTEM_XXXx defines to avoid confusion.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/VBox/shflsvc.h

    r75380 r75383  
    11/** @file
    2  * Shared Folders: Common header for host service and guest clients.
     2 * Shared Folders - Common header for host service and guest clients.
    33 */
    44
    … …  
    4545
    4646
     47
     48/** @defgroup grp_vbox_shfl     Shared Folder Interface Definition.
     49 *
     50 * Structures shared between guest and the service can be relocated and use
     51 * offsets to point to variable length parts.
     52 *
     53 * Shared folders protocol works with handles.  Before doing any action on a
     54 * file system object, one have to obtain the object handle via a SHFL_FN_CREATE
     55 * request. A handle must be closed with SHFL_FN_CLOSE.
     56 *
     57 * @{
     58 */
     59
    4760/** @name Some bit flag manipulation macros.
    4861 * @{  */
    … …  
    6174
    6275
    63 /**
    64  * Structures shared between guest and the service
    65  * can be relocated and use offsets to point to variable
    66  * length parts.
    67  */
    68 
    69 /**
    70  * Shared folders protocol works with handles.
    71  * Before doing any action on a file system object,
    72  * one have to obtain the object handle via a SHFL_FN_CREATE
    73  * request. A handle must be closed with SHFL_FN_CLOSE.
    74  */
    75 
    76 /** Shared Folders service functions. (guest)
    77  *  @{
    78  */
    79 
     76/** @name Shared Folders service functions. (guest)
     77 * @{
     78 */
    8079/** Query mappings changes. */
    8180#define SHFL_FN_QUERY_MAPPINGS      (1)
    … …  
    116115/** Ask host to show symlinks (as of VBox 4.0) */
    117116#define SHFL_FN_SET_SYMLINKS        (20)
    118 
    119 /** @} */
     117/** @} */
     118
    120119
    121120/** Shared Folders service functions. (host)
    122  *  @{
    123  */
    124 
     121 * @{
     122 */
    125123/** Add shared folder mapping. */
    126124#define SHFL_FN_ADD_MAPPING         (1)
    … …  
    133131/** @} */
    134132
     133
    135134/** Root handle for a mapping. Root handles are unique.
    136  *  @note
    137  *  Function parameters structures consider
    138  *  the root handle as 32 bit value. If the typedef
    139  *  will be changed, then function parameters must be
    140  *  changed accordingly. All those parameters are marked
    141  *  with SHFLROOT in comments.
     135 *
     136 * @note Function parameters structures consider the root handle as 32 bit
     137 *       value. If the typedef will be changed, then function parameters must be
     138 *       changed accordingly. All those parameters are marked with SHFLROOT in
     139 *       comments.
    142140 */
    143141typedef uint32_t SHFLROOT;
    144142
     143/** NIL shared folder root handle. */
    145144#define SHFL_ROOT_NIL ((SHFLROOT)~0)
    146145
    … …  
    156155/** Hardcoded maximum number of shared folder mapping available to the guest. */
    157156#define SHFL_MAX_MAPPINGS    (64)
     157
    158158
    159159/** @name Shared Folders strings. They can be either UTF-8 or UTF-16.
    … …  
    681681
    682682
    683 /** Open/create flags.
     683/** @name Open/create flags.
    684684 *  @{
    685685 */
    … …  
    787787
    788788
    789 /** Shared Folders mappings.
    790  *  @{
     789/** @name Shared Folders mappings.
     790 * @{
    791791 */
    792792
    … …  
    808808/** @} */
    809809
    810 /** Shared Folder directory information
    811  *  @{
     810
     811/** @name Shared Folder directory information
     812 * @{
    812813 */
    813814
    … …  
    901902/** @} */
    902903
    903 /** Function parameter structures.
    904  *  @{
    905  */
    906 
    907 /**
    908  * SHFL_FN_QUERY_MAPPINGS
     904
     905/** @defgroup grp_vbox_shfl_params  Function parameter structures.
     906 * @{
     907 */
     908
     909/** @name SHFL_FN_QUERY_MAPPINGS
     910 * @{
    909911 */
    910912/** Validation mask.  Needs to be adjusted
    911913  * whenever a new SHFL_MF_ flag is added. */
    912914#define SHFL_MF_MASK       (0x00000011)
    913 /** UC2 enconded strings. */
     915/** UTF-16 enconded strings. */
    914916#define SHFL_MF_UCS2       (0x00000000)
    915917/** Guest uses UTF8 strings, if not set then the strings are unicode (UCS2). */
    … …  
    918920#define SHFL_MF_AUTOMOUNT  (0x00000010)
    919921
    920 /** Type of guest system. For future system dependent features. */
    921 #define SHFL_MF_SYSTEM_MASK    (0x0000FF00)
    922 #define SHFL_MF_SYSTEM_NONE    (0x00000000)
    923 #define SHFL_MF_SYSTEM_WINDOWS (0x00000100)
    924 #define SHFL_MF_SYSTEM_LINUX   (0x00000200)
    925 
    926922/** Parameters structure. */
    927923typedef struct _VBoxSFQueryMappings
    … …  
    950946/** Number of parameters */
    951947#define SHFL_CPARMS_QUERY_MAPPINGS (3)
    952 
    953 
    954 
    955 /**
    956  * SHFL_FN_QUERY_MAP_NAME
     948/** @} */
     949
     950
     951/** @name SHFL_FN_QUERY_MAP_NAME
     952 * @{
    957953 */
    958954
    … …  
    976972/** Number of parameters */
    977973#define SHFL_CPARMS_QUERY_MAP_NAME (2)
    978 
    979 /**
    980  * SHFL_FN_MAP_FOLDER_OLD
     974/** @} */
     975
     976
     977/** @name SHFL_FN_MAP_FOLDER_OLD
     978 * @{
    981979 */
    982980
    … …  
    10051003/** Number of parameters */
    10061004#define SHFL_CPARMS_MAP_FOLDER_OLD (3)
    1007 
    1008 /**
    1009  * SHFL_FN_MAP_FOLDER
     1005/** @} */
     1006
     1007
     1008/** @name SHFL_FN_MAP_FOLDER
     1009 * @{
    10101010 */
    10111011
    … …  
    10391039/** Number of parameters */
    10401040#define SHFL_CPARMS_MAP_FOLDER (4)
    1041 
    1042 /**
    1043  * SHFL_FN_UNMAP_FOLDER
     1041/** @} */
     1042
     1043
     1044/** @name SHFL_FN_UNMAP_FOLDER
     1045 * @{
    10441046 */
    10451047
    … …  
    10581060/** Number of parameters */
    10591061#define SHFL_CPARMS_UNMAP_FOLDER (1)
    1060 
    1061 
    1062 /**
    1063  * SHFL_FN_CREATE
     1062/** @} */
     1063
     1064
     1065/** @name SHFL_FN_CREATE
     1066 * @{
    10641067 */
    10651068
    … …  
    10881091/** Number of parameters */
    10891092#define SHFL_CPARMS_CREATE (3)
    1090 
    1091 
    1092 /**
    1093  * SHFL_FN_CLOSE
     1093/** @} */
     1094
     1095
     1096/** @name SHFL_FN_CLOSE
     1097 * @{
    10941098 */
    10951099
    … …  
    11141118/** Number of parameters */
    11151119#define SHFL_CPARMS_CLOSE (2)
    1116 
    1117 
    1118 /**
    1119  * SHFL_FN_READ
     1120/** @} */
     1121
     1122
     1123/** @name  SHFL_FN_READ
     1124 * @{
    11201125 */
    11211126
    … …  
    11541159/** Number of parameters */
    11551160#define SHFL_CPARMS_READ (5)
    1156 
    1157 
    1158 
    1159 /**
    1160  * SHFL_FN_WRITE
     1161/** @} */
     1162
     1163
     1164/** @name SHFL_FN_WRITE
     1165 * @{
    11611166 */
    11621167
    … …  
    11951200/** Number of parameters */
    11961201#define SHFL_CPARMS_WRITE (5)
    1197 
    1198 
    1199 
    1200 /**
    1201  * SHFL_FN_LOCK
    1202  */
    1203 
    1204 /** Lock owner is the HGCM client. */
     1202/** @} */
     1203
     1204
     1205/** @name SHFL_FN_LOCK
     1206 * @remarks Lock owner is the HGCM client.
     1207 * @{
     1208 */
    12051209
    12061210/** Lock mode bit mask. */
    … …  
    12571261/** Number of parameters */
    12581262#define SHFL_CPARMS_LOCK (5)
    1259 
    1260 
    1261 
    1262 /**
    1263  * SHFL_FN_FLUSH
     1263/** @} */
     1264
     1265
     1266/** @name SHFL_FN_FLUSH
     1267 * @{
    12641268 */
    12651269
    … …  
    12831287/** Number of parameters */
    12841288#define SHFL_CPARMS_FLUSH (2)
    1285 
    1286 /**
    1287  * SHFL_FN_LIST
    1288  */
    1289 
    1290 /** Listing information includes variable length RTDIRENTRY[EX] structures. */
     1289/** @} */
     1290
     1291
     1292/** @name SHFL_FN_LIST
     1293 * @remarks Listing information includes variable length RTDIRENTRY[EX]
     1294 *          structures.
     1295 * @{
     1296 */
    12911297
    12921298/** @todo might be necessary for future. */
    12931299#define SHFL_LIST_NONE          0
    1294 #define SHFL_LIST_RETURN_ONE        1
     1300#define SHFL_LIST_RETURN_ONE    1
    12951301
    12961302/** Parameters structure. */
    … …  
    13451351/** Number of parameters */
    13461352#define SHFL_CPARMS_LIST (8)
    1347 
    1348 
    1349 
    1350 /**
    1351  * SHFL_FN_READLINK
     1353/** @} */
     1354
     1355
     1356/** @name SHFL_FN_READLINK
     1357 * @{
    13521358 */
    13531359
    … …  
    13761382/** Number of parameters */
    13771383#define SHFL_CPARMS_READLINK (3)
    1378 
    1379 
    1380 
    1381 /**
    1382  * SHFL_FN_INFORMATION
     1384/** @} */
     1385
     1386
     1387/** @name SHFL_FN_INFORMATION
     1388 * @{
    13831389 */
    13841390
    … …  
    14371443/** Number of parameters */
    14381444#define SHFL_CPARMS_INFORMATION (5)
    1439 
    1440 
    1441 /**
    1442  * SHFL_FN_REMOVE
     1445/** @}  */
     1446
     1447
     1448/** @name SHFL_FN_REMOVE
     1449 * @{
    14431450 */
    14441451
    … …  
    14701477
    14711478#define SHFL_CPARMS_REMOVE  (3)
    1472 
    1473 
    1474 /**
    1475  * SHFL_FN_RENAME
     1479/** @} */
     1480
     1481
     1482/** @name SHFL_FN_RENAME
     1483 * @{
    14761484 */
    14771485
    … …  
    15081516
    15091517#define SHFL_CPARMS_RENAME  (4)
    1510 
    1511 
    1512 /**
    1513  * SHFL_FN_SYMLINK
     1518/** @} */
     1519
     1520
     1521/** @name SHFL_FN_SYMLINK
     1522 * @{
    15141523 */
    15151524
    … …  
    15421551
    15431552#define SHFL_CPARMS_SYMLINK  (4)
    1544 
    1545 
    1546 
    1547 /**
    1548  * SHFL_FN_ADD_MAPPING
    1549  * Host call, no guest structure is used.
     1553/** @} */
     1554
     1555
     1556
     1557/** @name SHFL_FN_ADD_MAPPING
     1558 * @note  Host call, no guest structure is used.
     1559 * @{
    15501560 */
    15511561
    … …  
    15601570
    15611571#define SHFL_CPARMS_ADD_MAPPING  (4)
    1562 
    1563 /**
    1564  * SHFL_FN_REMOVE_MAPPING
    1565  * Host call, no guest structure is used.
     1572/** @} */
     1573
     1574
     1575/** @name SHFL_FN_REMOVE_MAPPING
     1576 * @note  Host call, no guest structure is used.
     1577 * @{
    15661578 */
    15671579
    15681580#define SHFL_CPARMS_REMOVE_MAPPING (1)
    1569 
    1570 
    1571 /**
    1572  * SHFL_FN_SET_STATUS_LED
    1573  * Host call, no guest structure is used.
     1581/** @} */
     1582
     1583
     1584/** @name SHFL_FN_SET_STATUS_LED
     1585 * @note  Host call, no guest structure is used.
     1586 * @{
    15741587 */
    15751588
    15761589#define SHFL_CPARMS_SET_STATUS_LED (1)
    1577 
     1590/** @} */
     1591
     1592
     1593/** @} */
    15781594/** @} */
    15791595
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette