VirtualBox

Changeset 100367 in vbox for trunk/include/VBox/HostServices


Ignore:
Timestamp:
Jul 4, 2023 4:23:18 PM (19 months ago)
Author:
vboxsync
Message:

Shared Clipboard: More work on making the internal APIs more fine grained and easier to follow. bugref:9437

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/VBox/HostServices/VBoxClipboardSvc.h

    r100234 r100367  
    330330 * @retval  VERR_WRONG_PARAMETER_COUNT
    331331 * @retval  VERR_WRONG_PARAMETER_TYPE
    332  * @since   6.1.0
     332 * @since   7.1.0
    333333 */
    334334#define VBOX_SHCL_GUEST_FN_REPORT_FEATURES          6
    … …  
    343343 * @retval  VERR_WRONG_PARAMETER_COUNT
    344344 * @retval  VERR_WRONG_PARAMETER_TYPE
    345  * @since   6.1.0
     345 * @since   7.1.0
    346346 */
    347347#define VBOX_SHCL_GUEST_FN_QUERY_FEATURES           7
    … …  
    365365 * @retval  VERR_WRONG_PARAMETER_COUNT
    366366 * @retval  VERR_WRONG_PARAMETER_TYPE
    367  * @since   6.1.0
     367 * @since   7.1.0
    368368 */
    369369#define VBOX_SHCL_GUEST_FN_MSG_PEEK_NOWAIT          8
    … …  
    393393 * @retval  VERR_WRONG_PARAMETER_TYPE
    394394 * @note    This replaces VBOX_SHCL_GUEST_FN_MSG_OLD_GET_WAIT.
    395  * @since   6.1.0
     395 * @since   7.1.0
    396396 */
    397397#define VBOX_SHCL_GUEST_FN_MSG_PEEK_WAIT            9
    … …  
    440440 * @since   6.1.x
    441441 */
    442 #define VBOX_SHCL_GUEST_FN_REPLY                  11
    443 /** Gets the root list header from the host.
    444  *
    445  * @retval  VINF_SUCCESS on success.
    446  * @retval  VERR_INVALID_CLIENT_ID
    447  * @retval  VERR_WRONG_PARAMETER_COUNT
    448  * @retval  VERR_WRONG_PARAMETER_TYPE
    449  * @since   6.1.x
    450  */
    451 #define VBOX_SHCL_GUEST_FN_ROOT_LIST_HDR_READ     12
    452 /** Sends the root list header to the host.
    453  *
    454  * @retval  VINF_SUCCESS on success.
    455  * @retval  VERR_INVALID_CLIENT_ID
    456  * @retval  VERR_WRONG_PARAMETER_COUNT
    457  * @retval  VERR_WRONG_PARAMETER_TYPE
    458  * @since   7.1.x
    459  */
    460 #define VBOX_SHCL_GUEST_FN_ROOT_LIST_HDR_WRITE    13
    461 /** Gets a root list root entry from the host.
    462  *
    463  * @retval  VINF_SUCCESS on success.
    464  * @retval  VERR_INVALID_CLIENT_ID
    465  * @retval  VERR_WRONG_PARAMETER_COUNT
    466  * @retval  VERR_WRONG_PARAMETER_TYPE
    467  * @since   7.1.x
    468  */
    469 #define VBOX_SHCL_GUEST_FN_ROOT_LIST_ENTRY_READ   14
    470 /** Sends a root list root entry to the host.
    471  *
    472  * @retval  VINF_SUCCESS on success.
    473  * @retval  VERR_INVALID_CLIENT_ID
    474  * @retval  VERR_WRONG_PARAMETER_COUNT
    475  * @retval  VERR_WRONG_PARAMETER_TYPE
    476  * @since   7.1.x
    477  */
    478 #define VBOX_SHCL_GUEST_FN_ROOT_LIST_ENTRY_WRITE  15
    479 /** Opens / gets a list handle from the host.
    480  *
    481  * @retval  VINF_SUCCESS on success.
    482  * @retval  VERR_INVALID_CLIENT_ID
    483  * @retval  VERR_WRONG_PARAMETER_COUNT
    484  * @retval  VERR_WRONG_PARAMETER_TYPE
    485  * @since   7.1.x
    486  */
    487 #define VBOX_SHCL_GUEST_FN_LIST_OPEN              16
    488 /** Closes a list handle from the host.
    489  *
    490  * @retval  VINF_SUCCESS on success.
    491  * @retval  VERR_INVALID_CLIENT_ID
    492  * @retval  VERR_WRONG_PARAMETER_COUNT
    493  * @retval  VERR_WRONG_PARAMETER_TYPE
    494  * @since   7.1.x
    495  */
    496 #define VBOX_SHCL_GUEST_FN_LIST_CLOSE             17
    497 /** Reads a list header from the host.
    498  *
    499  * @retval  VINF_SUCCESS on success.
    500  * @retval  VERR_INVALID_CLIENT_ID
    501  * @retval  VERR_WRONG_PARAMETER_COUNT
    502  * @retval  VERR_WRONG_PARAMETER_TYPE
    503  * @since   7.1.x
    504  */
    505 #define VBOX_SHCL_GUEST_FN_LIST_HDR_READ          18
    506 /** Writes a list header to the host.
    507  *
    508  * @retval  VINF_SUCCESS on success.
    509  * @retval  VERR_INVALID_CLIENT_ID
    510  * @retval  VERR_WRONG_PARAMETER_COUNT
    511  * @retval  VERR_WRONG_PARAMETER_TYPE
    512  * @since   7.1.x
    513  */
    514 #define VBOX_SHCL_GUEST_FN_LIST_HDR_WRITE         19
    515 /** Reads a list entry from the host.
    516  *
    517  * @retval  VINF_SUCCESS on success.
    518  * @retval  VERR_INVALID_CLIENT_ID
    519  * @retval  VERR_WRONG_PARAMETER_COUNT
    520  * @retval  VERR_WRONG_PARAMETER_TYPE
    521  * @since   7.1.x
    522  */
    523 #define VBOX_SHCL_GUEST_FN_LIST_ENTRY_READ        20
    524 /** Sends a list entry to the host.
    525  *
    526  * @retval  VINF_SUCCESS on success.
    527  * @retval  VERR_INVALID_CLIENT_ID
    528  * @retval  VERR_WRONG_PARAMETER_COUNT
    529  * @retval  VERR_WRONG_PARAMETER_TYPE
    530  * @since   7.1.x
    531  */
    532 #define VBOX_SHCL_GUEST_FN_LIST_ENTRY_WRITE       21
    533 /** Opens an object on the host.
    534  *
    535  * @retval  VINF_SUCCESS on success.
    536  * @retval  VERR_INVALID_CLIENT_ID
    537  * @retval  VERR_WRONG_PARAMETER_COUNT
    538  * @retval  VERR_WRONG_PARAMETER_TYPE
    539  * @since   7.1.x
    540  */
    541 #define VBOX_SHCL_GUEST_FN_OBJ_OPEN               22
    542 /** Closes an object on the host.
    543  *
    544  * @retval  VINF_SUCCESS on success.
    545  * @retval  VERR_INVALID_CLIENT_ID
    546  * @retval  VERR_WRONG_PARAMETER_COUNT
    547  * @retval  VERR_WRONG_PARAMETER_TYPE
    548  * @since   7.1.x
    549  */
    550 #define VBOX_SHCL_GUEST_FN_OBJ_CLOSE              23
    551 /** Reads from an object on the host.
    552  *
    553  * @retval  VINF_SUCCESS on success.
    554  * @retval  VERR_INVALID_CLIENT_ID
    555  * @retval  VERR_WRONG_PARAMETER_COUNT
    556  * @retval  VERR_WRONG_PARAMETER_TYPE
    557  * @since   7.1.x
    558  */
    559 #define VBOX_SHCL_GUEST_FN_OBJ_READ               24
    560 /** Writes to an object on the host.
    561  *
    562  * @retval  VINF_SUCCESS on success.
    563  * @retval  VERR_INVALID_CLIENT_ID
    564  * @retval  VERR_WRONG_PARAMETER_COUNT
    565  * @retval  VERR_WRONG_PARAMETER_TYPE
    566  * @since   7.1.x
    567  */
    568 #define VBOX_SHCL_GUEST_FN_OBJ_WRITE              25
    569 /** Reports an error to the host.
     442#define VBOX_SHCL_GUEST_FN_REPLY                 11
     443/** Gets the transfer root list header from the host.
     444 *
     445 * @retval  VINF_SUCCESS on success.
     446 * @retval  VERR_INVALID_CLIENT_ID
     447 * @retval  VERR_WRONG_PARAMETER_COUNT
     448 * @retval  VERR_WRONG_PARAMETER_TYPE
     449 * @since   7.1.x
     450 */
     451#define VBOX_SHCL_GUEST_FN_ROOT_LIST_HDR_READ    12
     452/** Sends the transfer root list header to the host.
     453 *
     454 * @retval  VINF_SUCCESS on success.
     455 * @retval  VERR_INVALID_CLIENT_ID
     456 * @retval  VERR_WRONG_PARAMETER_COUNT
     457 * @retval  VERR_WRONG_PARAMETER_TYPE
     458 * @since   7.1.x
     459 */
     460#define VBOX_SHCL_GUEST_FN_ROOT_LIST_HDR_WRITE   13
     461/** Gets a transfer root list root entry from the host.
     462 *
     463 * @retval  VINF_SUCCESS on success.
     464 * @retval  VERR_INVALID_CLIENT_ID
     465 * @retval  VERR_WRONG_PARAMETER_COUNT
     466 * @retval  VERR_WRONG_PARAMETER_TYPE
     467 * @since   7.1.x
     468 */
     469#define VBOX_SHCL_GUEST_FN_ROOT_LIST_ENTRY_READ  14
     470/** Sends a transfer root list root entry to the host.
     471 *
     472 * @retval  VINF_SUCCESS on success.
     473 * @retval  VERR_INVALID_CLIENT_ID
     474 * @retval  VERR_WRONG_PARAMETER_COUNT
     475 * @retval  VERR_WRONG_PARAMETER_TYPE
     476 * @since   7.1.x
     477 */
     478#define VBOX_SHCL_GUEST_FN_ROOT_LIST_ENTRY_WRITE 15
     479/** Opens / gets a transfer list handle from the host.
     480 *
     481 * @retval  VINF_SUCCESS on success.
     482 * @retval  VERR_INVALID_CLIENT_ID
     483 * @retval  VERR_WRONG_PARAMETER_COUNT
     484 * @retval  VERR_WRONG_PARAMETER_TYPE
     485 * @since   7.1.x
     486 */
     487#define VBOX_SHCL_GUEST_FN_LIST_OPEN             16
     488/** Closes a transfer list handle from the host.
     489 *
     490 * @retval  VINF_SUCCESS on success.
     491 * @retval  VERR_INVALID_CLIENT_ID
     492 * @retval  VERR_WRONG_PARAMETER_COUNT
     493 * @retval  VERR_WRONG_PARAMETER_TYPE
     494 * @since   7.1.x
     495 */
     496#define VBOX_SHCL_GUEST_FN_LIST_CLOSE            17
     497/** Reads a transfer list header from the host.
     498 *
     499 * @retval  VINF_SUCCESS on success.
     500 * @retval  VERR_INVALID_CLIENT_ID
     501 * @retval  VERR_WRONG_PARAMETER_COUNT
     502 * @retval  VERR_WRONG_PARAMETER_TYPE
     503 * @since   7.1.x
     504 */
     505#define VBOX_SHCL_GUEST_FN_LIST_HDR_READ         18
     506/** Writes a transfer list header to the host.
     507 *
     508 * @retval  VINF_SUCCESS on success.
     509 * @retval  VERR_INVALID_CLIENT_ID
     510 * @retval  VERR_WRONG_PARAMETER_COUNT
     511 * @retval  VERR_WRONG_PARAMETER_TYPE
     512 * @since   7.1.x
     513 */
     514#define VBOX_SHCL_GUEST_FN_LIST_HDR_WRITE        19
     515/** Reads a transfer list entry from the host.
     516 *
     517 * @retval  VINF_SUCCESS on success.
     518 * @retval  VERR_INVALID_CLIENT_ID
     519 * @retval  VERR_WRONG_PARAMETER_COUNT
     520 * @retval  VERR_WRONG_PARAMETER_TYPE
     521 * @since   7.1.x
     522 */
     523#define VBOX_SHCL_GUEST_FN_LIST_ENTRY_READ       20
     524/** Sends a transfer list entry to the host.
     525 *
     526 * @retval  VINF_SUCCESS on success.
     527 * @retval  VERR_INVALID_CLIENT_ID
     528 * @retval  VERR_WRONG_PARAMETER_COUNT
     529 * @retval  VERR_WRONG_PARAMETER_TYPE
     530 * @since   7.1.x
     531 */
     532#define VBOX_SHCL_GUEST_FN_LIST_ENTRY_WRITE      21
     533/** Opens a transfer object on the host.
     534 *
     535 * @retval  VINF_SUCCESS on success.
     536 * @retval  VERR_INVALID_CLIENT_ID
     537 * @retval  VERR_WRONG_PARAMETER_COUNT
     538 * @retval  VERR_WRONG_PARAMETER_TYPE
     539 * @since   7.1.x
     540 */
     541#define VBOX_SHCL_GUEST_FN_OBJ_OPEN              22
     542/** Closes a transfer object on the host.
     543 *
     544 * @retval  VINF_SUCCESS on success.
     545 * @retval  VERR_INVALID_CLIENT_ID
     546 * @retval  VERR_WRONG_PARAMETER_COUNT
     547 * @retval  VERR_WRONG_PARAMETER_TYPE
     548 * @since   7.1.x
     549 */
     550#define VBOX_SHCL_GUEST_FN_OBJ_CLOSE             23
     551/** Reads from a transfer object on the host.
     552 *
     553 * @retval  VINF_SUCCESS on success.
     554 * @retval  VERR_INVALID_CLIENT_ID
     555 * @retval  VERR_WRONG_PARAMETER_COUNT
     556 * @retval  VERR_WRONG_PARAMETER_TYPE
     557 * @since   7.1.x
     558 */
     559#define VBOX_SHCL_GUEST_FN_OBJ_READ              24
     560/** Writes to a transfer object on the host.
     561 *
     562 * @retval  VINF_SUCCESS on success.
     563 * @retval  VERR_INVALID_CLIENT_ID
     564 * @retval  VERR_WRONG_PARAMETER_COUNT
     565 * @retval  VERR_WRONG_PARAMETER_TYPE
     566 * @since   7.1.x
     567 */
     568#define VBOX_SHCL_GUEST_FN_OBJ_WRITE             25
     569/** Reports a transfer error to the host.
    570570 *
    571571 * @todo r=bird: Smells like GUEST_MSG_SKIP
    … …  
    577577 * @since   6.1
    578578 */
    579 #define VBOX_SHCL_GUEST_FN_ERROR                  27
     579#define VBOX_SHCL_GUEST_FN_ERROR                 27
    580580
    581581/** For negotiating a chunk size between the guest and host.
    … …  
    593593 * @retval  VERR_INVALID_PARAMETER if the 2nd parameter is larger than the
    594594 *          first one
    595  * @since   6.1
     595 * @since   7.1
    596596 */
    597597#define VBOX_SHCL_GUEST_FN_NEGOTIATE_CHUNK_SIZE     28
    … …  
    836836
    837837/** Invalid message type, do not use. */
    838 #define VBOX_SHCL_REPLYMSGTYPE_INVALID           0
     838#define VBOX_SHCL_TX_REPLYMSGTYPE_INVALID           0
    839839/** Replies a transfer status. */
    840 #define VBOX_SHCL_REPLYMSGTYPE_TRANSFER_STATUS   1
     840#define VBOX_SHCL_TX_REPLYMSGTYPE_TRANSFER_STATUS   1
    841841/** Replies a list open status. */
    842 #define VBOX_SHCL_REPLYMSGTYPE_LIST_OPEN         2
     842#define VBOX_SHCL_TX_REPLYMSGTYPE_LIST_OPEN         2
    843843/** Replies a list close status. */
    844 #define VBOX_SHCL_REPLYMSGTYPE_LIST_CLOSE        3
     844#define VBOX_SHCL_TX_REPLYMSGTYPE_LIST_CLOSE        3
    845845/** Replies an object open status. */
    846 #define VBOX_SHCL_REPLYMSGTYPE_OBJ_OPEN          4
     846#define VBOX_SHCL_TX_REPLYMSGTYPE_OBJ_OPEN          4
    847847/** Replies an object close status. */
    848 #define VBOX_SHCL_REPLYMSGTYPE_OBJ_CLOSE         5
     848#define VBOX_SHCL_TX_REPLYMSGTYPE_OBJ_CLOSE         5
    849849
    850850/**
    … …  
    857857    /** uint64_t, out: Context ID. */
    858858    HGCMFunctionParameter uContext;
    859     /** uint32_t, out: Message type of type VBOX_SHCL_REPLYMSGTYPE_XXX. */
     859    /** uint32_t, out: Message type of type VBOX_SHCL_TX_REPLYMSGTYPE_XXX. */
    860860    HGCMFunctionParameter enmType;
    861861    /** uint32_t, out: IPRT result of overall operation. */
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