Changeset 99954 in vbox
Legend:
- Unmodified
- Added
- Removed
-
trunk/include/VBox/GuestHost/SharedClipboard-transfers.h
r99951 r99954 693 693 typedef struct _SHCLTXPROVIDERIFACE 694 694 { 695 /** 696 * Returns the root entries of a clipboard transfer. 697 * 698 * @returns VBox status code. 699 * @param pCtx Provider context to use. 700 * @param ppRootList Where to store the root list on success. 701 */ 695 702 DECLCALLBACKMEMBER(int, pfnRootsGet,(PSHCLTXPROVIDERCTX pCtx, PSHCLROOTLIST *ppRootList)); 703 /** 704 * Opens a transfer list. 705 * 706 * @returns VBox status code. 707 * @param pCtx Provider context to use. 708 * @param pOpenParms List open parameters to use for opening. 709 * @param phList Where to store the List handle of opened list on success. 710 */ 696 711 DECLCALLBACKMEMBER(int, pfnListOpen,(PSHCLTXPROVIDERCTX pCtx, PSHCLLISTOPENPARMS pOpenParms, PSHCLLISTHANDLE phList)); 712 /** 713 * Closes a transfer list. 714 * 715 * @returns VBox status code. 716 * @param pCtx Provider context to use. 717 * @param hList Handle of list to close. 718 */ 697 719 DECLCALLBACKMEMBER(int, pfnListClose,(PSHCLTXPROVIDERCTX pCtx, SHCLLISTHANDLE hList)); 720 /** 721 * Reads the list header. 722 * 723 * @returns VBox status code. 724 * @param pCtx Provider context to use. 725 * @param hList List handle of list to read header for. 726 * @param pListHdr Where to store the list header read. 727 */ 698 728 DECLCALLBACKMEMBER(int, pfnListHdrRead,(PSHCLTXPROVIDERCTX pCtx, SHCLLISTHANDLE hList, PSHCLLISTHDR pListHdr)); 729 /** 730 * Writes the list header. 731 * 732 * @returns VBox status code. 733 * @param pCtx Provider context to use. 734 * @param hList List handle of list to write header for. 735 * @param pListHdr List header to write. 736 */ 699 737 DECLCALLBACKMEMBER(int, pfnListHdrWrite,(PSHCLTXPROVIDERCTX pCtx, SHCLLISTHANDLE hList, PSHCLLISTHDR pListHdr)); 738 /** 739 * Reads a single transfer list entry. 740 * 741 * @returns VBox status code or VERR_NO_MORE_FILES if the end of the list has been reached. 742 * @param pCtx Provider context to use. 743 * @param hList List handle of list to read from. 744 * @param pEntry Where to store the read information. 745 */ 700 746 DECLCALLBACKMEMBER(int, pfnListEntryRead,(PSHCLTXPROVIDERCTX pCtx, SHCLLISTHANDLE hList, PSHCLLISTENTRY pEntry)); 747 /** 748 * Writes a single transfer list entry. 749 * 750 * @returns VBox status code. 751 * @param pCtx Provider context to use. 752 * @param hList List handle of list to write to. 753 * @param pEntry Entry information to write. 754 */ 701 755 DECLCALLBACKMEMBER(int, pfnListEntryWrite,(PSHCLTXPROVIDERCTX pCtx, SHCLLISTHANDLE hList, PSHCLLISTENTRY pEntry)); 756 /** 757 * Opens a transfer object. 758 * 759 * @returns VBox status code. 760 * @param pCtx Provider context to use. 761 * @param pOpenCreateParms Open / create parameters of transfer object to open / create. 762 * @param phObj Where to store the handle of transfer object opened on success. 763 */ 702 764 DECLCALLBACKMEMBER(int, pfnObjOpen,(PSHCLTXPROVIDERCTX pCtx, PSHCLOBJOPENCREATEPARMS pCreateParms, PSHCLOBJHANDLE phObj)); 765 /** 766 * Closes a transfer object. 767 * 768 * @returns VBox status code. 769 * @param pCtx Provider context to use. 770 * @param hObj Handle of transfer object to close. 771 */ 703 772 DECLCALLBACKMEMBER(int, pfnObjClose,(PSHCLTXPROVIDERCTX pCtx, SHCLOBJHANDLE hObj)); 773 /** 774 * Reads from a transfer object. 775 * 776 * @returns VBox status code. 777 * @param pCtx Provider context to use. 778 * @param hObj Handle of transfer object to read from. 779 * @param pvBuf Buffer for where to store the read data. 780 * @param cbBuf Size (in bytes) of buffer. 781 * @param fFlags Read flags. Optional. 782 * @param pcbRead Where to return how much bytes were read on success. Optional. 783 */ 704 784 DECLCALLBACKMEMBER(int, pfnObjRead,(PSHCLTXPROVIDERCTX pCtx, SHCLOBJHANDLE hObj, void *pvData, uint32_t cbData, 705 785 uint32_t fFlags, uint32_t *pcbRead)); 786 /** 787 * Writes to a transfer object. 788 * 789 * @returns VBox status code. 790 * @param pCtx Provider context to use. 791 * @param hObj Handle of transfer object to write to. 792 * @param pvBuf Buffer of data to write. 793 * @param cbBuf Size (in bytes) of buffer to write. 794 * @param fFlags Write flags. Optional. 795 * @param pcbWritten How much bytes were writtenon success. Optional. 796 */ 706 797 DECLCALLBACKMEMBER(int, pfnObjWrite,(PSHCLTXPROVIDERCTX pCtx, SHCLOBJHANDLE hObj, void *pvData, uint32_t cbData, 707 798 uint32_t fFlags, uint32_t *pcbWritten)); -
trunk/src/VBox/Additions/common/VBoxGuest/lib/VBoxGuestR3LibClipboard.cpp
r99951 r99954 1702 1702 *********************************************************************************************************************************/ 1703 1703 1704 static DECLCALLBACK(int) vbglR3ClipboardTransferIfaceGetRoots(PSHCLTXPROVIDERCTX pCtx, PSHCLROOTLIST *ppRootList) 1704 /** @copydoc SHCLTXPROVIDERIFACE::pfnRootsGet */ 1705 static DECLCALLBACK(int) vbglR3ClipboardTransferIfaceRootsGet(PSHCLTXPROVIDERCTX pCtx, PSHCLROOTLIST *ppRootList) 1705 1706 { 1706 1707 LogFlowFuncEnter(); … … 1715 1716 } 1716 1717 1718 /** @copydoc SHCLTXPROVIDERIFACE::pfnListOpen */ 1717 1719 static DECLCALLBACK(int) vbglR3ClipboardTransferIfaceListOpen(PSHCLTXPROVIDERCTX pCtx, PSHCLLISTOPENPARMS pOpenParms, 1718 1720 PSHCLLISTHANDLE phList) … … 1729 1731 } 1730 1732 1733 /** @copydoc SHCLTXPROVIDERIFACE::pfnListClose */ 1731 1734 static DECLCALLBACK(int) vbglR3ClipboardTransferIfaceListClose(PSHCLTXPROVIDERCTX pCtx, SHCLLISTHANDLE hList) 1732 1735 { … … 1742 1745 } 1743 1746 1747 /** @copydoc SHCLTXPROVIDERIFACE::pfnListHdrRead */ 1744 1748 static DECLCALLBACK(int) vbglR3ClipboardTransferIfaceListHdrRead(PSHCLTXPROVIDERCTX pCtx, 1745 1749 SHCLLISTHANDLE hList, PSHCLLISTHDR pListHdr) … … 1765 1769 } 1766 1770 1771 /** @copydoc SHCLTXPROVIDERIFACE::pfnListEntryRead */ 1767 1772 static DECLCALLBACK(int) vbglR3ClipboardTransferIfaceListEntryRead(PSHCLTXPROVIDERCTX pCtx, 1768 1773 SHCLLISTHANDLE hList, PSHCLLISTENTRY pEntry) … … 1779 1784 } 1780 1785 1786 /** @copydoc SHCLTXPROVIDERIFACE::pfnObjOpen */ 1781 1787 static DECLCALLBACK(int) vbglR3ClipboardTransferIfaceObjOpen(PSHCLTXPROVIDERCTX pCtx, 1782 1788 PSHCLOBJOPENCREATEPARMS pCreateParms, PSHCLOBJHANDLE phObj) … … 1793 1799 } 1794 1800 1801 /** @copydoc SHCLTXPROVIDERIFACE::pfnObjClose */ 1795 1802 static DECLCALLBACK(int) vbglR3ClipboardTransferIfaceObjClose(PSHCLTXPROVIDERCTX pCtx, SHCLOBJHANDLE hObj) 1796 1803 { … … 1806 1813 } 1807 1814 1815 /** @copydoc SHCLTXPROVIDERIFACE::pfnObjRead */ 1808 1816 static DECLCALLBACK(int) vbglR3ClipboardTransferIfaceObjRead(PSHCLTXPROVIDERCTX pCtx, 1809 1817 SHCLOBJHANDLE hObj, void *pvData, uint32_t cbData, … … 1860 1868 if (enmDir == SHCLTRANSFERDIR_FROM_REMOTE) 1861 1869 { 1862 creationCtx.Interface.pfnRootsGet = vbglR3ClipboardTransferIface GetRoots;1870 creationCtx.Interface.pfnRootsGet = vbglR3ClipboardTransferIfaceRootsGet; 1863 1871 1864 1872 creationCtx.Interface.pfnListOpen = vbglR3ClipboardTransferIfaceListOpen; -
trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-transfers.cpp
r99951 r99954 97 97 *********************************************************************************************************************************/ 98 98 99 /** @copydoc SHCLTXPROVIDERIFACE::pfnRootsGet */ 99 100 DECLCALLBACK(int) shClSvcTransferIfaceRootsGet(PSHCLTXPROVIDERCTX pCtx, PSHCLROOTLIST *ppRootList) 100 101 { … … 220 221 } 221 222 223 /** @copydoc SHCLTXPROVIDERIFACE::pfnListOpen */ 222 224 DECLCALLBACK(int) shClSvcTransferIfaceListOpen(PSHCLTXPROVIDERCTX pCtx, 223 225 PSHCLLISTOPENPARMS pOpenParms, PSHCLLISTHANDLE phList) … … 281 283 } 282 284 285 /** @copydoc SHCLTXPROVIDERIFACE::pfnListClose */ 283 286 DECLCALLBACK(int) shClSvcTransferIfaceListClose(PSHCLTXPROVIDERCTX pCtx, SHCLLISTHANDLE hList) 284 287 { … … 328 331 } 329 332 333 /** @copydoc SHCLTXPROVIDERIFACE::pfnListHdrRead */ 330 334 DECLCALLBACK(int) shClSvcTransferIfaceListHdrRead(PSHCLTXPROVIDERCTX pCtx, 331 335 SHCLLISTHANDLE hList, PSHCLLISTHDR pListHdr) … … 380 384 } 381 385 386 /** @copydoc SHCLTXPROVIDERIFACE::pfnListHdrWrite */ 382 387 DECLCALLBACK(int) shClSvcTransferIfaceListHdrWrite(PSHCLTXPROVIDERCTX pCtx, 383 388 SHCLLISTHANDLE hList, PSHCLLISTHDR pListHdr) … … 390 395 } 391 396 397 /** @copydoc SHCLTXPROVIDERIFACE::pfnListEntryRead */ 392 398 DECLCALLBACK(int) shClSvcTransferIfaceListEntryRead(PSHCLTXPROVIDERCTX pCtx, 393 399 SHCLLISTHANDLE hList, PSHCLLISTENTRY pListEntry) … … 442 448 } 443 449 450 /** @copydoc SHCLTXPROVIDERIFACE::pfnListEntryWrite */ 444 451 DECLCALLBACK(int) shClSvcTransferIfaceListEntryWrite(PSHCLTXPROVIDERCTX pCtx, 445 452 SHCLLISTHANDLE hList, PSHCLLISTENTRY pListEntry) … … 452 459 } 453 460 461 /** @copydoc SHCLTXPROVIDERIFACE::pfnObjOpen */ 454 462 int shClSvcTransferIfaceObjOpen(PSHCLTXPROVIDERCTX pCtx, PSHCLOBJOPENCREATEPARMS pCreateParms, 455 463 PSHCLOBJHANDLE phObj) … … 517 525 } 518 526 527 /** @copydoc SHCLTXPROVIDERIFACE::pfnObjClose */ 519 528 int shClSvcTransferIfaceObjClose(PSHCLTXPROVIDERCTX pCtx, SHCLOBJHANDLE hObj) 520 529 { … … 572 581 } 573 582 583 /** @copydoc SHCLTXPROVIDERIFACE::pfnObjRead */ 574 584 int shClSvcTransferIfaceObjRead(PSHCLTXPROVIDERCTX pCtx, SHCLOBJHANDLE hObj, 575 585 void *pvData, uint32_t cbData, uint32_t fFlags, uint32_t *pcbRead) … … 633 643 } 634 644 645 /** @copydoc SHCLTXPROVIDERIFACE::pfnObjWrite */ 635 646 int shClSvcTransferIfaceObjWrite(PSHCLTXPROVIDERCTX pCtx, SHCLOBJHANDLE hObj, 636 647 void *pvData, uint32_t cbData, uint32_t fFlags, uint32_t *pcbWritten)
Note:
See TracChangeset
for help on using the changeset viewer.

