Changeset 81154 in vbox for trunk/src/VBox/Additions/common
- Timestamp:
- Oct 8, 2019 2:24:01 PM (5 years ago)
- svn:sync-xref-src-repo-rev:
- 133788
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/VBox/Additions/common/VBoxGuest/lib/VBoxGuestR3LibClipboard.cpp
r81059 r81154 165 165 166 166 167 /** 168 * Receives reported formats from the host. 169 * 170 * @returns VBox status code. 171 * @param pCtx Shared Clipboard command context to use for the connection. 172 * @param pFormats Where to store the received formats from the host. 173 */ 167 174 VBGLR3DECL(int) VbglR3ClipboardFormatsReportRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLFORMATDATA pFormats) 168 175 { … … 198 205 199 206 207 /** 208 * Receives a host request to read clipboard data request from the guest. 209 * 210 * @returns VBox status code. 211 * @param pCtx Shared Clipboard command context to use for the connection. 212 * @param pDataReq Where to store the read data request from the host. 213 */ 200 214 VBGLR3DECL(int) VbglR3ClipboardReadDataRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLDATAREQ pDataReq) 201 215 { … … 375 389 376 390 #ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS 391 /** 392 * Reads a root list header from the host. 393 * 394 * @returns VBox status code. 395 * @param pCtx Shared Clipboard command context to use for the connection. 396 * @param pRootListHdr Where to store the received root list header. 397 */ 377 398 static int vbglR3ClipboardRootListHdrRead(PVBGLR3SHCLCMDCTX pCtx, PSHCLROOTLISTHDR pRootListHdr) 378 399 { … … 403 424 } 404 425 426 /** 427 * Reads a root list entry from the host. 428 * 429 * @returns VBox status code. 430 * @param pCtx Shared Clipboard command context to use for the connection. 431 * @param uIndex Index of root list entry to read. 432 * @param pRootListEntry Where to store the root list entry read from the host. 433 */ 405 434 static int vbglR3ClipboardRootListEntryRead(PVBGLR3SHCLCMDCTX pCtx, uint32_t uIndex, PSHCLROOTLISTENTRY pRootListEntry) 406 435 { … … 439 468 } 440 469 470 /** 471 * Reads the root list from the host. 472 * 473 * @returns VBox status code. 474 * @param pCtx Shared Clipboard command context to use for the connection. 475 * @param ppRootList Where to store the (allocated) root list. Must be free'd by the caller with 476 * SharedClipboardTransferRootListFree(). 477 */ 441 478 VBGLR3DECL(int) VbglR3ClipboardRootListRead(PVBGLR3SHCLCMDCTX pCtx, PSHCLROOTLIST *ppRootList) 442 479 { … … 488 525 } 489 526 527 /** 528 * Receives a transfer status from the host. 529 * 530 * @returns VBox status code. 531 * @param pCtx Shared Clipboard command context to use for the connection. 532 * @param pEnmDir Where to store the transfer direction for the reported transfer. 533 * @param pReport Where to store the transfer (status) report. 534 */ 490 535 VBGLR3DECL(int) VbglR3ClipboarTransferStatusRecv(PVBGLR3SHCLCMDCTX pCtx, 491 536 PSHCLTRANSFERDIR pEnmDir, PSHCLTRANSFERREPORT pReport) … … 525 570 } 526 571 572 /** 573 * Replies to a transfer report from the host. 574 * 575 * @returns VBox status code. 576 * @param pCtx Shared Clipboard command context to use for the connection. 577 * @param pTransfer Transfer of report to reply to. 578 * @param uStatus Tranfer status to reply. 579 * @param rcTransfer Result code (rc) to reply. 580 */ 527 581 VBGLR3DECL(int) VbglR3ClipboardTransferStatusReply(PVBGLR3SHCLCMDCTX pCtx, PSHCLTRANSFER pTransfer, 528 582 SHCLTRANSFERSTATUS uStatus, int rcTransfer) … … 555 609 } 556 610 611 /** 612 * Receives a host request to read a root list header from the guest. 613 * 614 * @returns VBox status code. 615 * @param pCtx Shared Clipboard command context to use for the connection. 616 * @param pfRoots Where to store the root list header flags to use, requested by the host. 617 */ 557 618 VBGLR3DECL(int) VbglR3ClipboardRootListHdrReadReq(PVBGLR3SHCLCMDCTX pCtx, uint32_t *pfRoots) 558 619 { … … 581 642 } 582 643 644 /** 645 * Replies to a root list header request. 646 * 647 * @returns VBox status code. 648 * @param pCtx Shared Clipboard command context to use for the connection. 649 * @param pRootListHdr Root lsit header to reply to the host. 650 */ 583 651 VBGLR3DECL(int) VbglR3ClipboardRootListHdrReadReply(PVBGLR3SHCLCMDCTX pCtx, PSHCLROOTLISTHDR pRootListHdr) 584 652 { … … 603 671 } 604 672 673 /** 674 * Receives a host request to read a root list entry from the guest. 675 * 676 * @returns VBox status code. 677 * @param pCtx Shared Clipboard command context to use for the connection. 678 * @param puIndex Where to return the index of the root list entry the host wants to read. 679 * @param pfInfo Where to return the read flags the host wants to use. 680 */ 605 681 VBGLR3DECL(int) VbglR3ClipboardRootListEntryReadReq(PVBGLR3SHCLCMDCTX pCtx, uint32_t *puIndex, uint32_t *pfInfo) 606 682 { … … 633 709 } 634 710 711 /** 712 * Replies to a root list entry read request from the host. 713 * 714 * @returns VBox status code. 715 * @param pCtx Shared Clipboard command context to use for the connection. 716 * @param uIndex Index of root list entry to reply. 717 * @param pEntry Actual root list entry to reply. 718 */ 635 719 VBGLR3DECL(int) VbglR3ClipboardRootListEntryReadReply(PVBGLR3SHCLCMDCTX pCtx, uint32_t uIndex, PSHCLROOTLISTENTRY pEntry) 636 720 { … … 658 742 } 659 743 744 /** 745 * Sends a request to open a list handle to the host. 746 * 747 * @returns VBox status code. 748 * @param pCtx Shared Clipboard command context to use for the connection. 749 * @param pOpenParms List open parameters to use for the open request. 750 * @param phList Where to return the list handle received from the host. 751 */ 660 752 VBGLR3DECL(int) VbglR3ClipboardListOpenSend(PVBGLR3SHCLCMDCTX pCtx, PSHCLLISTOPENPARMS pOpenParms, 661 753 PSHCLLISTHANDLE phList) … … 688 780 } 689 781 782 /** 783 * Receives a host request to open a list handle on the guest. 784 * 785 * @returns VBox status code. 786 * @param pCtx Shared Clipboard command context to use for the connection. 787 * @param pOpenParms Where to store the open parameters the host wants to use for opening the list handle. 788 */ 690 789 VBGLR3DECL(int) VbglR3ClipboardListOpenRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLLISTOPENPARMS pOpenParms) 691 790 { … … 723 822 } 724 823 824 /** 825 * Replies to a list open request from the host. 826 * 827 * @returns VBox status code. 828 * @param pCtx Shared Clipboard command context to use for the connection. 829 * @param rcReply Return code to reply to the host. 830 * @param hList List handle of (guest) list to reply to the host. 831 */ 725 832 VBGLR3DECL(int) VbglR3ClipboardListOpenReply(PVBGLR3SHCLCMDCTX pCtx, int rcReply, SHCLLISTHANDLE hList) 726 833 { … … 747 854 } 748 855 856 /** 857 * Receives a host request to close a list handle on the guest. 858 * 859 * @returns VBox status code. 860 * @param pCtx Shared Clipboard command context to use for the connection. 861 * @param phList Where to store the list handle to close, received from the host. 862 */ 749 863 VBGLR3DECL(int) VbglR3ClipboardListCloseRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLLISTHANDLE phList) 750 864 { … … 773 887 } 774 888 889 /** 890 * Replies to a list handle close request from the host. 891 * 892 * @returns VBox status code. 893 * @param pCtx Shared Clipboard command context to use for the connection. 894 * @param rcReply Return code to reply to the host. 895 * @param hList List handle the send the close reply for. 896 */ 775 897 VBGLR3DECL(int) VbglR3ClipboardListCloseReply(PVBGLR3SHCLCMDCTX pCtx, int rcReply, SHCLLISTHANDLE hList) 776 898 { … … 797 919 } 798 920 921 /** 922 * Sends a request to close a list handle to the host. 923 * 924 * @returns VBox status code. 925 * @param pCtx Shared Clipboard command context to use for the connection. 926 * @param hList List handle to request for closing on the host. 927 */ 799 928 VBGLR3DECL(int) VbglR3ClipboardListCloseSend(PVBGLR3SHCLCMDCTX pCtx, SHCLLISTHANDLE hList) 800 929 { … … 816 945 } 817 946 818 947 /** 948 * Sends a request to read a list header to the host. 949 * 950 * @returns VBox status code. 951 * @param pCtx Shared Clipboard command context to use for the connection. 952 * @param hList List handle to read list header for. 953 * @param fFlags List header read flags to use. 954 * @param pListHdr Where to return the list header received from the host. 955 */ 819 956 VBGLR3DECL(int) VbglR3ClipboardListHdrRead(PVBGLR3SHCLCMDCTX pCtx, SHCLLISTHANDLE hList, uint32_t fFlags, 820 957 PSHCLLISTHDR pListHdr) … … 852 989 } 853 990 991 /** 992 * Receives a host request to read a list header on the guest. 993 * 994 * @returns VBox status code. 995 * @param pCtx Shared Clipboard command context to use for the connection. 996 * @param phList Where to return the list handle to read list header for. 997 * @param pfFlags Where to return the List header read flags to use. 998 */ 854 999 VBGLR3DECL(int) VbglR3ClipboardListHdrReadRecvReq(PVBGLR3SHCLCMDCTX pCtx, PSHCLLISTHANDLE phList, uint32_t *pfFlags) 855 1000 { … … 882 1027 } 883 1028 1029 /** 1030 * Sends (writes) a list header to the host. 1031 * 1032 * @returns VBox status code. 1033 * @param pCtx Shared Clipboard command context to use for the connection. 1034 * @param hList List handle to write list header for. 1035 * @param pListHdr List header to write. 1036 */ 884 1037 VBGLR3DECL(int) VbglR3ClipboardListHdrWrite(PVBGLR3SHCLCMDCTX pCtx, SHCLLISTHANDLE hList, 885 1038 PSHCLLISTHDR pListHdr) … … 909 1062 } 910 1063 1064 /** 1065 * Sends a reuqest to read a list entry from the host. 1066 * 1067 * @returns VBox status code. 1068 * @param pCtx Shared Clipboard command context to use for the connection. 1069 * @param hList List handle to request to read a list entry for. 1070 * @param pListEntry Where to return the list entry read from the host. 1071 */ 911 1072 VBGLR3DECL(int) VbglR3ClipboardListEntryRead(PVBGLR3SHCLCMDCTX pCtx, SHCLLISTHANDLE hList, 912 1073 PSHCLLISTENTRY pListEntry) … … 939 1100 } 940 1101 1102 /** 1103 * Receives a host request to read a list entry from the guest. 1104 * 1105 * @returns VBox status code. 1106 * @param pCtx Shared Clipboard command context to use for the connection. 1107 * @param phList Where to return the list handle to read a list entry for. 1108 * @param pfInfo Where to return the list read flags. 1109 */ 941 1110 VBGLR3DECL(int) VbglR3ClipboardListEntryReadRecvReq(PVBGLR3SHCLCMDCTX pCtx, PSHCLLISTHANDLE phList, uint32_t *pfInfo) 942 1111 { … … 969 1138 } 970 1139 1140 /** 1141 * Sends (writes) a list entry to the host. 1142 * 1143 * @returns VBox status code. 1144 * @param pCtx Shared Clipboard command context to use for the connection. 1145 * @param hList List handle to write a list etnry for. 1146 * @param pListEntry List entry to write. 1147 */ 971 1148 VBGLR3DECL(int) VbglR3ClipboardListEntryWrite(PVBGLR3SHCLCMDCTX pCtx, SHCLLISTHANDLE hList, 972 1149 PSHCLLISTENTRY pListEntry) … … 995 1172 } 996 1173 1174 /** 1175 * Receives a host request to open an object on the guest. 1176 * 1177 * @returns VBox status code. 1178 * @param pCtx Shared Clipboard command context to use for the connection. 1179 * @param pCreateParms Where to store the object open/create parameters received from the host. 1180 */ 997 1181 VBGLR3DECL(int) VbglR3ClipboardObjOpenRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLOBJOPENCREATEPARMS pCreateParms) 998 1182 { … … 1026 1210 } 1027 1211 1212 /** 1213 * Replies a host request to open an object. 1214 * 1215 * @returns VBox status code. 1216 * @param pCtx Shared Clipboard command context to use for the connection. 1217 * @param rcReply Return code to reply to the host. 1218 * @param hObj Object handle of opened object to reply to the host. 1219 */ 1028 1220 VBGLR3DECL(int) VbglR3ClipboardObjOpenReply(PVBGLR3SHCLCMDCTX pCtx, int rcReply, SHCLOBJHANDLE hObj) 1029 1221 { … … 1050 1242 } 1051 1243 1244 /** 1245 * Sends an object open request to the host. 1246 * 1247 * @returns VBox status code. 1248 * @param pCtx Shared Clipboard command context to use for the connection. 1249 * @param pCreateParms Object open/create parameters to use for opening the object on the host. 1250 * @param phObj Where to return the object handle from the host. 1251 */ 1052 1252 VBGLR3DECL(int) VbglR3ClipboardObjOpenSend(PVBGLR3SHCLCMDCTX pCtx, PSHCLOBJOPENCREATEPARMS pCreateParms, 1053 1253 PSHCLOBJHANDLE phObj) … … 1079 1279 } 1080 1280 1281 /** 1282 * Receives a host request to close an object on the guest. 1283 * 1284 * @returns VBox status code. 1285 * @param pCtx Shared Clipboard command context to use for the connection. 1286 * @param phObj Where to return the object handle to close from the host. 1287 */ 1081 1288 VBGLR3DECL(int) VbglR3ClipboardObjCloseRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLOBJHANDLE phObj) 1082 1289 { … … 1105 1312 } 1106 1313 1314 /** 1315 * Replies to an object open request from the host. 1316 * 1317 * @returns VBox status code. 1318 * @param pCtx Shared Clipboard command context to use for the connection. 1319 * @param rcReply Return code to reply to the host. 1320 * @param hObj Object handle to reply to the host. 1321 */ 1107 1322 VBGLR3DECL(int) VbglR3ClipboardObjCloseReply(PVBGLR3SHCLCMDCTX pCtx, int rcReply, SHCLOBJHANDLE hObj) 1108 1323 { … … 1129 1344 } 1130 1345 1346 /** 1347 * Sends a request to close an object to the host. 1348 * 1349 * @returns VBox status code. 1350 * @param pCtx Shared Clipboard command context to use for the connection. 1351 * @param hObj Object handle to close on the host. 1352 */ 1131 1353 VBGLR3DECL(int) VbglR3ClipboardObjCloseSend(PVBGLR3SHCLCMDCTX pCtx, SHCLOBJHANDLE hObj) 1132 1354 { … … 1148 1370 } 1149 1371 1372 /** 1373 * Receives a host request to read from an object on the guest. 1374 * 1375 * @returns VBox status code. 1376 * @param pCtx Shared Clipboard command context to use for the connection. 1377 * @param phObj Where to return the object handle to read from. 1378 * @param pcbToRead Where to return the amount (in bytes) to read. 1379 * @param pfFlags Where to return the read flags. 1380 */ 1150 1381 VBGLR3DECL(int) VbglR3ClipboardObjReadRecv(PVBGLR3SHCLCMDCTX pCtx, PSHCLOBJHANDLE phObj, uint32_t *pcbToRead, 1151 1382 uint32_t *pfFlags) … … 1183 1414 } 1184 1415 1416 /** 1417 * Sends a request to read from an object to the host. 1418 * 1419 * @returns VBox status code. 1420 * @param pCtx Shared Clipboard command context to use for the connection. 1421 * @param hObj Object handle of object to read from. 1422 * @param pvData Buffer where to store the read object data. 1423 * @param cbData Size (in bytes) of buffer. 1424 * @param pcbRead Where to store the amount (in bytes) read from the object. 1425 */ 1185 1426 VBGLR3DECL(int) VbglR3ClipboardObjReadSend(PVBGLR3SHCLCMDCTX pCtx, SHCLOBJHANDLE hObj, 1186 1427 void *pvData, uint32_t cbData, uint32_t *pcbRead) … … 1220 1461 } 1221 1462 1463 /** 1464 * Sends a request to write to an object to the host. 1465 * 1466 * @returns VBox status code. 1467 * @param pCtx Shared Clipboard command context to use for the connection. 1468 * @param hObj Object handle of object to write to. 1469 * @param pvData Buffer of data to write to object. 1470 * @param cbData Size (in bytes) of buffer. 1471 * @param pcbWritten Where to store the amount (in bytes) written to the object. 1472 */ 1222 1473 VBGLR3DECL(int) VbglR3ClipboardObjWriteSend(PVBGLR3SHCLCMDCTX pCtx, SHCLOBJHANDLE hObj, 1223 1474 void *pvData, uint32_t cbData, uint32_t *pcbWritten)
Note:
See TracChangeset
for help on using the changeset viewer.
