Changeset 80847 in vbox for trunk/include/VBox/HostServices
- Timestamp:
- Sep 17, 2019 9:38:16 AM (6 years ago)
- svn:sync-xref-src-repo-rev:
- 133417
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/include/VBox/HostServices/VBoxClipboardSvc.h
r80845 r80847 66 66 */ 67 67 /** Older saved states (VBox < 6.1). Includes protocol v0 state. */ 68 #define VBOX_SH ARED_CLIPBOARD_SSM_VER_0 UINT32_C(0x80000002)68 #define VBOX_SHCL_SSM_VER_0 UINT32_C(0x80000002) 69 69 /** Protocol v1 is being used. */ 70 #define VBOX_SH ARED_CLIPBOARD_SSM_VER_1 UINT32_C(0x80000003)70 #define VBOX_SHCL_SSM_VER_1 UINT32_C(0x80000003) 71 71 72 72 /* 73 73 * The mode of operations. 74 74 */ 75 #define VBOX_SH ARED_CLIPBOARD_MODE_OFF 076 #define VBOX_SH ARED_CLIPBOARD_MODE_HOST_TO_GUEST 177 #define VBOX_SH ARED_CLIPBOARD_MODE_GUEST_TO_HOST 278 #define VBOX_SH ARED_CLIPBOARD_MODE_BIDIRECTIONAL 375 #define VBOX_SHCL_MODE_OFF 0 76 #define VBOX_SHCL_MODE_HOST_TO_GUEST 1 77 #define VBOX_SHCL_MODE_GUEST_TO_HOST 2 78 #define VBOX_SHCL_MODE_BIDIRECTIONAL 3 79 79 80 80 /* … … 82 82 */ 83 83 /** Sets the current Shared Clipboard operation mode. */ 84 #define VBOX_SH ARED_CLIPBOARD_HOST_FN_SET_MODE 184 #define VBOX_SHCL_HOST_FN_SET_MODE 1 85 85 /** Run headless on the host, i.e. do not touch the host clipboard. */ 86 #define VBOX_SH ARED_CLIPBOARD_HOST_FN_SET_HEADLESS 286 #define VBOX_SHCL_HOST_FN_SET_HEADLESS 2 87 87 /** Reports cancellation of the current operation to the guest. */ 88 #define VBOX_SH ARED_CLIPBOARD_HOST_FN_CANCEL 388 #define VBOX_SHCL_HOST_FN_CANCEL 3 89 89 /** Reports an error to the guest. */ 90 #define VBOX_SH ARED_CLIPBOARD_HOST_FN_ERROR 490 #define VBOX_SHCL_HOST_FN_ERROR 4 91 91 /** Reports that a new clipboard area has been registered. */ 92 #define VBOX_SH ARED_CLIPBOARD_HOST_FN_AREA_REGISTER 592 #define VBOX_SHCL_HOST_FN_AREA_REGISTER 5 93 93 /** Reports that a clipboard area has been unregistered. */ 94 #define VBOX_SH ARED_CLIPBOARD_HOST_FN_AREA_UNREGISTER 694 #define VBOX_SHCL_HOST_FN_AREA_UNREGISTER 6 95 95 /** Reports that a client (host / guest) has attached to a clipboard area. */ 96 #define VBOX_SH ARED_CLIPBOARD_HOST_FN_AREA_ATTACH 796 #define VBOX_SHCL_HOST_FN_AREA_ATTACH 7 97 97 /** Reports that a client (host / guest) has detached from a clipboard area. */ 98 #define VBOX_SH ARED_CLIPBOARD_HOST_FN_AREA_DETACH 898 #define VBOX_SHCL_HOST_FN_AREA_DETACH 8 99 99 100 100 /** … … 102 102 */ 103 103 /** Asks the client to quit / terminate. */ 104 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_QUIT 1104 #define VBOX_SHCL_HOST_MSG_QUIT 1 105 105 /** Reads (simple) data from the guest. */ 106 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_READ_DATA 2106 #define VBOX_SHCL_HOST_MSG_READ_DATA 2 107 107 /** Reports available clipboard format from host to the guest. 108 * Formerly known as VBOX_SH ARED_CLIPBOARD_HOST_MSG_REPORT_FORMATS. */109 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_FORMATS_REPORT 3108 * Formerly known as VBOX_SHCL_HOST_MSG_REPORT_FORMATS. */ 109 #define VBOX_SHCL_HOST_MSG_FORMATS_REPORT 3 110 110 111 111 /** Sends a transfer status to the guest side. */ 112 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_URI_TRANSFER_STATUS 50112 #define VBOX_SHCL_HOST_MSG_URI_TRANSFER_STATUS 50 113 113 /** Reads the root list header from the guest. */ 114 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_URI_ROOT_LIST_HDR_READ 51114 #define VBOX_SHCL_HOST_MSG_URI_ROOT_LIST_HDR_READ 51 115 115 /** Writes the root list header to the guest. */ 116 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_URI_ROOT_LIST_HDR_WRITE 52116 #define VBOX_SHCL_HOST_MSG_URI_ROOT_LIST_HDR_WRITE 52 117 117 /** Reads a root list entry from the guest. */ 118 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_URI_ROOT_LIST_ENTRY_READ 53118 #define VBOX_SHCL_HOST_MSG_URI_ROOT_LIST_ENTRY_READ 53 119 119 /** Writes a root list entry to the guest. */ 120 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_URI_ROOT_LIST_ENTRY_WRITE 54120 #define VBOX_SHCL_HOST_MSG_URI_ROOT_LIST_ENTRY_WRITE 54 121 121 /** Open an URI list on the guest side. */ 122 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_URI_LIST_OPEN 55122 #define VBOX_SHCL_HOST_MSG_URI_LIST_OPEN 55 123 123 /** Closes a formerly opened URI list on the guest side. */ 124 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_URI_LIST_CLOSE 56124 #define VBOX_SHCL_HOST_MSG_URI_LIST_CLOSE 56 125 125 /** Reads a list header from the guest. */ 126 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_URI_LIST_HDR_READ 57126 #define VBOX_SHCL_HOST_MSG_URI_LIST_HDR_READ 57 127 127 /** Writes a list header to the guest. */ 128 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_URI_LIST_HDR_WRITE 58128 #define VBOX_SHCL_HOST_MSG_URI_LIST_HDR_WRITE 58 129 129 /** Reads a list entry from the guest. */ 130 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_URI_LIST_ENTRY_READ 59130 #define VBOX_SHCL_HOST_MSG_URI_LIST_ENTRY_READ 59 131 131 /** Writes a list entry to the guest. */ 132 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_URI_LIST_ENTRY_WRITE 60132 #define VBOX_SHCL_HOST_MSG_URI_LIST_ENTRY_WRITE 60 133 133 /** Open an URI object on the guest side. */ 134 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_URI_OBJ_OPEN 61134 #define VBOX_SHCL_HOST_MSG_URI_OBJ_OPEN 61 135 135 /** Closes a formerly opened URI object on the guest side. */ 136 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_URI_OBJ_CLOSE 62136 #define VBOX_SHCL_HOST_MSG_URI_OBJ_CLOSE 62 137 137 /** Reads from an object on the guest side. */ 138 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_URI_OBJ_READ 63138 #define VBOX_SHCL_HOST_MSG_URI_OBJ_READ 63 139 139 /** Writes to an object on the guest side. */ 140 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_URI_OBJ_WRITE 64140 #define VBOX_SHCL_HOST_MSG_URI_OBJ_WRITE 64 141 141 /** Indicates that the host has canceled a transfer. */ 142 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_URI_CANCEL 65142 #define VBOX_SHCL_HOST_MSG_URI_CANCEL 65 143 143 /** Indicates that the an unrecoverable error on the host occurred . */ 144 #define VBOX_SH ARED_CLIPBOARD_HOST_MSG_URI_ERROR 66144 #define VBOX_SHCL_HOST_MSG_URI_ERROR 66 145 145 146 146 /* 147 147 * The service functions which are called by guest. 148 148 */ 149 /** Calls the host and waits (blocking) for an host event VBOX_SH ARED_CLIPBOARD_HOST_MSG_*.149 /** Calls the host and waits (blocking) for an host event VBOX_SHCL_HOST_MSG_*. 150 150 * Note: This is the old message which still is being used for the non-URI Shared Clipboard transfers, 151 151 * to not break compatibility with older Guest Additions / VBox versions. */ 152 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_GET_HOST_MSG_OLD 1152 #define VBOX_SHCL_GUEST_FN_GET_HOST_MSG_OLD 1 153 153 /** Sends a list of available formats to the host. 154 * Formely known as VBOX_SH ARED_CLIPBOARD_GUEST_FN_REPORT_FORMATS. */155 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_FORMATS_REPORT 2154 * Formely known as VBOX_SHCL_GUEST_FN_REPORT_FORMATS. */ 155 #define VBOX_SHCL_GUEST_FN_FORMATS_REPORT 2 156 156 /** Reads data in specified format from the host. */ 157 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_DATA_READ 3157 #define VBOX_SHCL_GUEST_FN_DATA_READ 3 158 158 /** Writes data in requested format to the host. */ 159 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_DATA_WRITE 4159 #define VBOX_SHCL_GUEST_FN_DATA_WRITE 4 160 160 161 161 /** Does the actual protocol handshake. If this message is not … … 164 164 * 165 165 * New since protocol v1. */ 166 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_CONNECT 5166 #define VBOX_SHCL_GUEST_FN_CONNECT 5 167 167 /** Peeks at the next message, returning immediately. 168 168 * New since protocol v1. */ 169 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_MSG_PEEK_NOWAIT 6169 #define VBOX_SHCL_GUEST_FN_MSG_PEEK_NOWAIT 6 170 170 /** Peeks at the next message, waiting for one to arrive. 171 171 * New since protocol v1. */ 172 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_MSG_PEEK_WAIT 7172 #define VBOX_SHCL_GUEST_FN_MSG_PEEK_WAIT 7 173 173 /** Gets the next message, returning immediately. 174 174 * New since protocol v1. */ 175 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_MSG_GET 8175 #define VBOX_SHCL_GUEST_FN_MSG_GET 8 176 176 /** Sends a transfer status to the host. 177 177 * New since protocol v1. */ 178 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_STATUS 9178 #define VBOX_SHCL_GUEST_FN_STATUS 9 179 179 /** Replies to a function from the host. 180 180 * New since protocol v1. */ 181 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_REPLY 10181 #define VBOX_SHCL_GUEST_FN_REPLY 10 182 182 /** Reports the available root entries of a transfer. 183 183 * New since protocol v1. */ 184 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_ROOT_LIST_HDR_READ 11184 #define VBOX_SHCL_GUEST_FN_ROOT_LIST_HDR_READ 11 185 185 /** Reports the available root entries of a transfer. 186 186 * New since protocol v1. */ 187 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_ROOT_LIST_HDR_WRITE 12187 #define VBOX_SHCL_GUEST_FN_ROOT_LIST_HDR_WRITE 12 188 188 /** Reports the available root entries of a transfer. 189 189 * New since protocol v1. */ 190 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_ROOT_LIST_ENTRY_READ 13190 #define VBOX_SHCL_GUEST_FN_ROOT_LIST_ENTRY_READ 13 191 191 /** Reports the available root entries of a transfer. 192 192 * New since protocol v1. */ 193 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_ROOT_LIST_ENTRY_WRITE 14193 #define VBOX_SHCL_GUEST_FN_ROOT_LIST_ENTRY_WRITE 14 194 194 /** Opens / gets a list handle from the host. 195 195 * New since protocol v1. */ 196 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_LIST_OPEN 15196 #define VBOX_SHCL_GUEST_FN_LIST_OPEN 15 197 197 /** Closes a list handle from the host. 198 198 * New since protocol v1. */ 199 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_LIST_CLOSE 16199 #define VBOX_SHCL_GUEST_FN_LIST_CLOSE 16 200 200 /** Reads a list header from the host. 201 201 * New since protocol v1. */ 202 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_LIST_HDR_READ 17202 #define VBOX_SHCL_GUEST_FN_LIST_HDR_READ 17 203 203 /** Writes a list header to the host. 204 204 * New since protocol v1. */ 205 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_LIST_HDR_WRITE 18205 #define VBOX_SHCL_GUEST_FN_LIST_HDR_WRITE 18 206 206 /** New since protocol v1. */ 207 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_LIST_ENTRY_READ 19207 #define VBOX_SHCL_GUEST_FN_LIST_ENTRY_READ 19 208 208 /** New since protocol v1. */ 209 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_LIST_ENTRY_WRITE 20209 #define VBOX_SHCL_GUEST_FN_LIST_ENTRY_WRITE 20 210 210 /** New since protocol v1. */ 211 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_OBJ_OPEN 21211 #define VBOX_SHCL_GUEST_FN_OBJ_OPEN 21 212 212 /** New since protocol v1. */ 213 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_OBJ_CLOSE 22213 #define VBOX_SHCL_GUEST_FN_OBJ_CLOSE 22 214 214 /** New since protocol v1. */ 215 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_OBJ_READ 23215 #define VBOX_SHCL_GUEST_FN_OBJ_READ 23 216 216 /** New since protocol v1. */ 217 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_OBJ_WRITE 24217 #define VBOX_SHCL_GUEST_FN_OBJ_WRITE 24 218 218 /** Reports cancellation of the current operation to the host. 219 219 * New since protocol v1. */ 220 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_CANCEL 25220 #define VBOX_SHCL_GUEST_FN_CANCEL 25 221 221 /** Reports an error to the host. 222 222 * New since protocol v1. */ 223 #define VBOX_SH ARED_CLIPBOARD_GUEST_FN_ERROR 26223 #define VBOX_SHCL_GUEST_FN_ERROR 26 224 224 225 225 /** The maximum default chunk size for a single data transfer. */ 226 #define VBOX_SH ARED_CLIPBOARD_MAX_CHUNK_SIZE _64K226 #define VBOX_SHCL_MAX_CHUNK_SIZE _64K 227 227 228 228 /* … … 235 235 * Kept for maintaining compatibility with older Guest Additions. 236 236 */ 237 typedef struct _VBox ClipboardGetHostMsgOld237 typedef struct _VBoxShClGetHostMsgOld 238 238 { 239 239 VBGLIOCHGCMCALL hdr; … … 241 241 /** uint32_t, out: Host message type. */ 242 242 HGCMFunctionParameter msg; 243 /** uint32_t, out: VBOX_SH ARED_CLIPBOARD_FMT_*, depends on the 'msg'.243 /** uint32_t, out: VBOX_SHCL_FMT_*, depends on the 'msg'. 244 244 * r=andy This actual can have *different* meanings, depending on the host message type. */ 245 245 HGCMFunctionParameter formats; /* OUT uint32_t */ 246 } VBox ClipboardGetHostMsgOld;247 248 #define VBOX_SH ARED_CLIPBOARD_CPARMS_GET_HOST_MSG_OLD 2246 } VBoxShClGetHostMsgOld; 247 248 #define VBOX_SHCL_CPARMS_GET_HOST_MSG_OLD 2 249 249 250 250 /** … … 252 252 * and the guest. Not available on older (VBox <= 6.0) hosts. 253 253 */ 254 typedef struct _VBox ClipboardConnect254 typedef struct _VBoxShClConnect 255 255 { 256 256 VBGLIOCHGCMCALL hdr; … … 266 266 /** uint32_t, in/out: Checksum type used for data transfer. Currently unused. */ 267 267 HGCMFunctionParameter enmChecksumType; 268 } VBox ClipboardConnect;269 270 #define VBOX_SH ARED_CLIPBOARD_CPARMS_CONNECT 5271 272 typedef struct _VBox ClipboardFormatsMsg268 } VBoxShClConnect; 269 270 #define VBOX_SHCL_CPARMS_CONNECT 5 271 272 typedef struct _VBoxShClFormatsMsg 273 273 { 274 274 VBGLIOCHGCMCALL hdr; … … 276 276 /** uint32_t, in: Context ID. */ 277 277 HGCMFunctionParameter uContext; 278 /** uint32_t, out: VBOX_SH ARED_CLIPBOARD_FMT_*. */278 /** uint32_t, out: VBOX_SHCL_FMT_*. */ 279 279 HGCMFunctionParameter uFormats; 280 280 /** uint32_t, in: Format flags. */ 281 281 HGCMFunctionParameter fFlags; 282 } VBox ClipboardFormatsMsg;283 284 typedef struct _VBox ClipboardReadDataReqMsg282 } VBoxShClFormatsMsg; 283 284 typedef struct _VBoxShClReadDataReqMsg 285 285 { 286 286 VBGLIOCHGCMCALL hdr; … … 292 292 /** uint32_t, out: Maximum size (in bytes) to read. */ 293 293 HGCMFunctionParameter cbSize; 294 } VBox ClipboardReadDataReqMsg;295 296 #define VBOX_SH ARED_CLIPBOARD_CPARMS_READ_DATA_REQ 2297 298 typedef struct _VBox ClipboardReadDataMsg294 } VBoxShClReadDataReqMsg; 295 296 #define VBOX_SHCL_CPARMS_READ_DATA_REQ 2 297 298 typedef struct _VBoxShClReadDataMsg 299 299 { 300 300 VBGLIOCHGCMCALL hdr; … … 309 309 HGCMFunctionParameter size; /* OUT uint32_t */ 310 310 311 } VBox ClipboardReadDataMsg;312 313 #define VBOX_SH ARED_CLIPBOARD_CPARMS_READ_DATA 3314 315 typedef struct _VBox ClipboardWriteDataMsg311 } VBoxShClReadDataMsg; 312 313 #define VBOX_SHCL_CPARMS_READ_DATA 3 314 315 typedef struct _VBoxShClWriteDataMsg 316 316 { 317 317 VBGLIOCHGCMCALL hdr; … … 321 321 struct 322 322 { 323 /** Returned format as requested in the VBOX_SH ARED_CLIPBOARD_HOST_MSG_READ_DATA message. */323 /** Returned format as requested in the VBOX_SHCL_HOST_MSG_READ_DATA message. */ 324 324 HGCMFunctionParameter format; /* IN uint32_t */ 325 325 /** Data. */ … … 338 338 } v1; 339 339 } u; 340 } VBox ClipboardWriteDataMsg;341 342 #define VBOX_SH ARED_CLIPBOARD_CPARMS_WRITE_DATA 4340 } VBoxShClWriteDataMsg; 341 342 #define VBOX_SHCL_CPARMS_WRITE_DATA 4 343 343 344 344 /** 345 345 * Reports a transfer status. 346 346 */ 347 typedef struct _VBox ClipboardTransferStatusMsg347 typedef struct _VBoxShClTransferStatusMsg 348 348 { 349 349 VBGLIOCHGCMCALL hdr; … … 359 359 /** uint32_t, out: Reporting flags. Currently unused and must be 0. */ 360 360 HGCMFunctionParameter fFlags; 361 } VBox ClipboardTransferStatusMsg;362 363 #define VBOX_SH ARED_CLIPBOARD_CPARMS_TRANSFER_STATUS 5361 } VBoxShClTransferStatusMsg; 362 363 #define VBOX_SHCL_CPARMS_TRANSFER_STATUS 5 364 364 365 365 /** … … 368 368 * flag. 369 369 * 370 * Used by: VBOX_SH ARED_CLIPBOARD_GUEST_FN_GET_HOST_MSG371 * 372 */ 373 typedef struct _VBox ClipboardGetHostMsg370 * Used by: VBOX_SHCL_GUEST_FN_GET_HOST_MSG 371 * 372 */ 373 typedef struct _VBoxShClGetHostMsg 374 374 { 375 375 VBGLIOCHGCMCALL hdr; … … 381 381 /** uint32_t, in: Whether or not to block (wait) for a new message to arrive. */ 382 382 HGCMFunctionParameter fBlock; 383 } VBox ClipboardPeekMsg;384 385 #define VBOX_SH ARED_CLIPBOARD_CPARMS_GET_HOST_MSG 3383 } VBoxShClPeekMsg; 384 385 #define VBOX_SHCL_CPARMS_GET_HOST_MSG 3 386 386 387 387 /** @todo might be necessary for future. */ … … 400 400 * Status messag for lists and objects. 401 401 */ 402 typedef struct _VBox ClipboardStatusMsg402 typedef struct _VBoxShClStatusMsg 403 403 { 404 404 VBGLIOCHGCMCALL hdr; … … 412 412 /** pointer, in: Optional payload of this status, based on the status type. */ 413 413 HGCMFunctionParameter pvPayload; 414 } VBox ClipboardStatusMsg;415 416 #define VBOX_SH ARED_CLIPBOARD_CPARMS_STATUS 4414 } VBoxShClStatusMsg; 415 416 #define VBOX_SHCL_CPARMS_STATUS 4 417 417 418 418 /** Invalid message type, do not use. */ … … 432 432 * Generic reply message. 433 433 */ 434 typedef struct _VBox ClipboardReplyMsg434 typedef struct _VBoxShClReplyMsg 435 435 { 436 436 VBGLIOCHGCMCALL hdr; … … 465 465 } ObjClose; 466 466 } u; 467 } VBox ClipboardReplyMsg;467 } VBoxShClReplyMsg; 468 468 469 469 /** Minimum parameters (HGCM function parameters minus the union) a reply message must have. */ 470 #define VBOX_SH ARED_CLIPBOARD_CPARMS_REPLY_MIN 5471 472 typedef struct _VBox ClipboardRootListParms470 #define VBOX_SHCL_CPARMS_REPLY_MIN 5 471 472 typedef struct _VBoxShClRootListParms 473 473 { 474 474 /** uint32_t, in: Context ID. s*/ … … 476 476 /** uint32_t, in: Roots listing flags; unused at the moment. */ 477 477 HGCMFunctionParameter fRoots; 478 } VBox ClipboardRootListParms;478 } VBoxShClRootListParms; 479 479 480 480 /** 481 481 * Requests to read the root list. 482 482 */ 483 typedef struct _VBox ClipboardRootListReadReqMsg484 { 485 VBGLIOCHGCMCALL hdr; 486 487 VBox ClipboardRootListParms ReqParms;488 } VBox ClipboardRootListReadReqMsg;489 490 #define VBOX_SH ARED_CLIPBOARD_CPARMS_ROOT_LIST_HDR_READ 2483 typedef struct _VBoxShClRootListReadReqMsg 484 { 485 VBGLIOCHGCMCALL hdr; 486 487 VBoxShClRootListParms ReqParms; 488 } VBoxShClRootListReadReqMsg; 489 490 #define VBOX_SHCL_CPARMS_ROOT_LIST_HDR_READ 2 491 491 492 492 /** 493 493 * Reads / Writes a root list header. 494 494 */ 495 typedef struct _VBox ClipboardRootListHdrMsg496 { 497 VBGLIOCHGCMCALL hdr; 498 499 VBox ClipboardRootListParms ReqParms;495 typedef struct _VBoxShClRootListHdrMsg 496 { 497 VBGLIOCHGCMCALL hdr; 498 499 VBoxShClRootListParms ReqParms; 500 500 /** uint64_t, in/out: Number of total root list entries. */ 501 501 HGCMFunctionParameter cRoots; 502 } VBox ClipboardRootListHdrMsg;503 504 #define VBOX_SH ARED_CLIPBOARD_CPARMS_ROOT_LIST_HDR 2505 506 typedef struct _VBox ClipboardRootListEntryParms502 } VBoxShClRootListHdrMsg; 503 504 #define VBOX_SHCL_CPARMS_ROOT_LIST_HDR 2 505 506 typedef struct _VBoxShClRootListEntryParms 507 507 { 508 508 /** uint32_t, in: Context ID. */ … … 512 512 /** uint32_t, in: Index of root list entry to get (zero-based). */ 513 513 HGCMFunctionParameter uIndex; 514 } VBox ClipboardRootListEntryParms;514 } VBoxShClRootListEntryParms; 515 515 516 516 /** 517 517 * Request to read a list root entry. 518 518 */ 519 typedef struct _VBox ClipboardRootListEntryReadReqMsg519 typedef struct _VBoxShClRootListEntryReadReqMsg 520 520 { 521 521 VBGLIOCHGCMCALL hdr; 522 522 523 523 /** in: Request parameters. */ 524 VBox ClipboardRootListEntryParms Parms;525 } VBox ClipboardRootListEntryReadReqMsg;526 527 #define VBOX_SH ARED_CLIPBOARD_CPARMS_ROOT_LIST_ENTRY_READ_REQ 3524 VBoxShClRootListEntryParms Parms; 525 } VBoxShClRootListEntryReadReqMsg; 526 527 #define VBOX_SHCL_CPARMS_ROOT_LIST_ENTRY_READ_REQ 3 528 528 529 529 /** 530 530 * Reads / Writes a root list entry. 531 531 */ 532 typedef struct _VBox ClipboardRootListEntryMsg532 typedef struct _VBoxShClRootListEntryMsg 533 533 { 534 534 VBGLIOCHGCMCALL hdr; 535 535 536 536 /** in/out: Request parameters. */ 537 VBox ClipboardRootListEntryParms Parms;537 VBoxShClRootListEntryParms Parms; 538 538 /** pointer, in/out: Entry name. */ 539 539 HGCMFunctionParameter szName; … … 543 543 * Do not forget to set the SHCLFSOBJINFO::Attr::enmAdditional for Get operation as well. */ 544 544 HGCMFunctionParameter pvInfo; 545 } VBox ClipboardRootListEntryMsg;546 547 #define VBOX_SH ARED_CLIPBOARD_CPARMS_ROOT_LIST_ENTRY 6545 } VBoxShClRootListEntryMsg; 546 547 #define VBOX_SHCL_CPARMS_ROOT_LIST_ENTRY 6 548 548 549 549 /** 550 550 * Opens a list. 551 551 */ 552 typedef struct _VBox ClipboardListOpenMsg552 typedef struct _VBoxShClListOpenMsg 553 553 { 554 554 VBGLIOCHGCMCALL hdr; … … 568 568 /** uint64_t, out: List handle. */ 569 569 HGCMFunctionParameter uHandle; 570 } VBox ClipboardListOpenMsg;571 572 #define VBOX_SH ARED_CLIPBOARD_CPARMS_LIST_OPEN 7570 } VBoxShClListOpenMsg; 571 572 #define VBOX_SHCL_CPARMS_LIST_OPEN 7 573 573 574 574 /** 575 575 * Closes a list. 576 576 */ 577 typedef struct _VBox ClipboardListCloseMsg577 typedef struct _VBoxShClListCloseMsg 578 578 { 579 579 VBGLIOCHGCMCALL hdr; … … 583 583 /** uint64_t, in: List handle. */ 584 584 HGCMFunctionParameter uHandle; 585 } VBox ClipboardListCloseMsg;586 587 #define VBOX_SH ARED_CLIPBOARD_CPARMS_LIST_CLOSE 2588 589 typedef struct _VBox ClipboardListHdrReqParms585 } VBoxShClListCloseMsg; 586 587 #define VBOX_SHCL_CPARMS_LIST_CLOSE 2 588 589 typedef struct _VBoxShClListHdrReqParms 590 590 { 591 591 /** uint32_t, in: Context ID. */ … … 595 595 /** uint32_t, in: Flags of type VBOX_SHCL_LISTHDR_FLAG_XXX. */ 596 596 HGCMFunctionParameter fFlags; 597 } VBox ClipboardListHdrReqParms;597 } VBoxShClListHdrReqParms; 598 598 599 599 /** 600 600 * Request to read a list header. 601 601 */ 602 typedef struct _VBox ClipboardListHdrReadReqMsg603 { 604 VBGLIOCHGCMCALL hdr; 605 606 VBox ClipboardListHdrReqParms ReqParms;607 } VBox ClipboardListHdrReadReqMsg;608 609 #define VBOX_SH ARED_CLIPBOARD_CPARMS_LIST_HDR_READ_REQ 3602 typedef struct _VBoxShClListHdrReadReqMsg 603 { 604 VBGLIOCHGCMCALL hdr; 605 606 VBoxShClListHdrReqParms ReqParms; 607 } VBoxShClListHdrReadReqMsg; 608 609 #define VBOX_SHCL_CPARMS_LIST_HDR_READ_REQ 3 610 610 611 611 /** 612 612 * Reads / Writes a list header. 613 613 */ 614 typedef struct _VBox ClipboardListHdrMsg615 { 616 VBGLIOCHGCMCALL hdr; 617 618 VBox ClipboardListHdrReqParms ReqParms;614 typedef struct _VBoxShClListHdrMsg 615 { 616 VBGLIOCHGCMCALL hdr; 617 618 VBoxShClListHdrReqParms ReqParms; 619 619 /** uint32_t, in/out: Feature flags (see VBOX_SHCL_FEATURE_FLAG_XXX). */ 620 620 HGCMFunctionParameter fFeatures; … … 623 623 /** uint64_t, in/out: Number of total bytes to transfer. */ 624 624 HGCMFunctionParameter cbTotalSize; 625 } VBox ClipboardListHdrMsg;626 627 #define VBOX_SH ARED_CLIPBOARD_CPARMS_LIST_HDR 6628 629 typedef struct _VBox ClipboardListEntryReqParms625 } VBoxShClListHdrMsg; 626 627 #define VBOX_SHCL_CPARMS_LIST_HDR 6 628 629 typedef struct _VBoxShClListEntryReqParms 630 630 { 631 631 /** uint32_t, in: Context ID. */ … … 635 635 /** uint32_t, in: VBOX_SHCL_INFO_FLAG_XXX. */ 636 636 HGCMFunctionParameter fInfo; 637 } VBox ClipboardListEntryReqParms;637 } VBoxShClListEntryReqParms; 638 638 639 639 /** 640 640 * Request to read a list entry. 641 641 */ 642 typedef struct _VBox ClipboardListEntryReadReqMsg643 { 644 VBGLIOCHGCMCALL hdr; 645 646 VBox ClipboardListEntryReqParms ReqParms;647 } VBox ClipboardListEntryReadReqMsg;648 649 #define VBOX_SH ARED_CLIPBOARD_CPARMS_LIST_ENTRY_READ 3642 typedef struct _VBoxShClListEntryReadReqMsg 643 { 644 VBGLIOCHGCMCALL hdr; 645 646 VBoxShClListEntryReqParms ReqParms; 647 } VBoxShClListEntryReadReqMsg; 648 649 #define VBOX_SHCL_CPARMS_LIST_ENTRY_READ 3 650 650 651 651 /** 652 652 * Reads / Writes a list entry. 653 653 */ 654 typedef struct _VBox ClipboardListEntryMsg654 typedef struct _VBoxShClListEntryMsg 655 655 { 656 656 VBGLIOCHGCMCALL hdr; 657 657 658 658 /** in/out: Request parameters. */ 659 VBox ClipboardListEntryReqParms ReqParms;659 VBoxShClListEntryReqParms ReqParms; 660 660 /** pointer, in/out: Entry name. */ 661 661 HGCMFunctionParameter szName; … … 665 665 * Do not forget to set the SHCLFSOBJINFO::Attr::enmAdditional for Get operation as well. */ 666 666 HGCMFunctionParameter pvInfo; 667 } VBox ClipboardListEntryMsg;668 669 #define VBOX_SH ARED_CLIPBOARD_CPARMS_LIST_ENTRY 6670 671 typedef struct _VBox ClipboardObjOpenMsg667 } VBoxShClListEntryMsg; 668 669 #define VBOX_SHCL_CPARMS_LIST_ENTRY 6 670 671 typedef struct _VBoxShClObjOpenMsg 672 672 { 673 673 VBGLIOCHGCMCALL hdr; … … 683 683 /** uint32_t in/out: Open / Create flags of type SHCL_OBJ_CF_. */ 684 684 HGCMFunctionParameter fCreate; 685 } VBox ClipboardObjOpenMsg;686 687 #define VBOX_SH ARED_CLIPBOARD_CPARMS_OBJ_OPEN 5688 689 typedef struct _VBox ClipboardObjCloseMsg685 } VBoxShClObjOpenMsg; 686 687 #define VBOX_SHCL_CPARMS_OBJ_OPEN 5 688 689 typedef struct _VBoxShClObjCloseMsg 690 690 { 691 691 VBGLIOCHGCMCALL hdr; … … 695 695 /** uint64_t, in: SHCLOBJHANDLE of object to close. */ 696 696 HGCMFunctionParameter uHandle; 697 } VBox ClipboardObjCloseMsg;698 699 #define VBOX_SH ARED_CLIPBOARD_CPARMS_OBJ_CLOSE 2700 701 typedef struct _VBox ClipboardObjReadReqParms697 } VBoxShClObjCloseMsg; 698 699 #define VBOX_SHCL_CPARMS_OBJ_CLOSE 2 700 701 typedef struct _VBoxShClObjReadReqParms 702 702 { 703 703 /** uint32_t, in: Context ID. */ … … 709 709 /** uint32_t, in: Read flags. Currently unused and must be 0. */ 710 710 HGCMFunctionParameter fRead; 711 } VBox ClipboardObjReadReqParms;712 713 typedef struct _VBox ClipboardObjReadReqMsg714 { 715 VBGLIOCHGCMCALL hdr; 716 717 VBox ClipboardObjReadReqParms ReqParms;718 } VBox ClipboardObjReadReqMsg;719 720 #define VBOX_SH ARED_CLIPBOARD_CPARMS_OBJ_READ_REQ 4711 } VBoxShClObjReadReqParms; 712 713 typedef struct _VBoxShClObjReadReqMsg 714 { 715 VBGLIOCHGCMCALL hdr; 716 717 VBoxShClObjReadReqParms ReqParms; 718 } VBoxShClObjReadReqMsg; 719 720 #define VBOX_SHCL_CPARMS_OBJ_READ_REQ 4 721 721 722 722 /** … … 724 724 * 725 725 * Used by: 726 * VBOX_SH ARED_CLIPBOARD_FN_OBJ_READ727 * VBOX_SH ARED_CLIPBOARD_FN_OBJ_WRITE728 */ 729 typedef struct _VBox ClipboardObjReadWriteMsg726 * VBOX_SHCL_FN_OBJ_READ 727 * VBOX_SHCL_FN_OBJ_WRITE 728 */ 729 typedef struct _VBoxShClObjReadWriteMsg 730 730 { 731 731 VBGLIOCHGCMCALL hdr; … … 744 744 * type in the data header. Optional. */ 745 745 HGCMFunctionParameter pvChecksum; 746 } VBox ClipboardObjReadWriteMsg;747 748 #define VBOX_SH ARED_CLIPBOARD_CPARMS_OBJ_READ 6749 #define VBOX_SH ARED_CLIPBOARD_CPARMS_OBJ_WRITE 6746 } VBoxShClObjReadWriteMsg; 747 748 #define VBOX_SHCL_CPARMS_OBJ_READ 6 749 #define VBOX_SHCL_CPARMS_OBJ_WRITE 6 750 750 751 751 /** … … 753 753 * 754 754 * Used by: 755 * VBOX_SH ARED_CLIPBOARD_FN_WRITE_ERROR756 */ 757 typedef struct _VBox ClipboardErrorMsg755 * VBOX_SHCL_FN_WRITE_ERROR 756 */ 757 typedef struct _VBoxShClErrorMsg 758 758 { 759 759 VBGLIOCHGCMCALL hdr; … … 763 763 /** uint32_t, in: The error code (IPRT-style). */ 764 764 HGCMFunctionParameter rc; 765 } VBox ClipboardWriteErrorMsg;766 767 #define VBOX_SH ARED_CLIPBOARD_CPARMS_ERROR 2765 } VBoxShClWriteErrorMsg; 766 767 #define VBOX_SHCL_CPARMS_ERROR 2 768 768 769 769 #pragma pack()
Note:
See TracChangeset
for help on using the changeset viewer.
