VirtualBox

Changeset 99954 in vbox for trunk


Ignore:
Timestamp:
May 24, 2023 11:03:01 AM (16 months ago)
Author:
vboxsync
Message:

Shared Clipboard: Docs. bugref:9437

Location:
trunk
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/include/VBox/GuestHost/SharedClipboard-transfers.h

    r99951 r99954  
    693693typedef struct _SHCLTXPROVIDERIFACE
    694694{
     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     */
    695702    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     */
    696711    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     */
    697719    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     */
    698728    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     */
    699737    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     */
    700746    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     */
    701755    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     */
    702764    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     */
    703772    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     */
    704784    DECLCALLBACKMEMBER(int, pfnObjRead,(PSHCLTXPROVIDERCTX pCtx, SHCLOBJHANDLE hObj, void *pvData, uint32_t cbData,
    705785                                        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     */
    706797    DECLCALLBACKMEMBER(int, pfnObjWrite,(PSHCLTXPROVIDERCTX pCtx, SHCLOBJHANDLE hObj, void *pvData, uint32_t cbData,
    707798                                         uint32_t fFlags, uint32_t *pcbWritten));
  • trunk/src/VBox/Additions/common/VBoxGuest/lib/VBoxGuestR3LibClipboard.cpp

    r99951 r99954  
    17021702*********************************************************************************************************************************/
    17031703
    1704 static DECLCALLBACK(int) vbglR3ClipboardTransferIfaceGetRoots(PSHCLTXPROVIDERCTX pCtx, PSHCLROOTLIST *ppRootList)
     1704/** @copydoc SHCLTXPROVIDERIFACE::pfnRootsGet */
     1705static DECLCALLBACK(int) vbglR3ClipboardTransferIfaceRootsGet(PSHCLTXPROVIDERCTX pCtx, PSHCLROOTLIST *ppRootList)
    17051706{
    17061707    LogFlowFuncEnter();
     
    17151716}
    17161717
     1718/** @copydoc SHCLTXPROVIDERIFACE::pfnListOpen */
    17171719static DECLCALLBACK(int) vbglR3ClipboardTransferIfaceListOpen(PSHCLTXPROVIDERCTX pCtx, PSHCLLISTOPENPARMS pOpenParms,
    17181720                                                              PSHCLLISTHANDLE phList)
     
    17291731}
    17301732
     1733/** @copydoc SHCLTXPROVIDERIFACE::pfnListClose */
    17311734static DECLCALLBACK(int) vbglR3ClipboardTransferIfaceListClose(PSHCLTXPROVIDERCTX pCtx, SHCLLISTHANDLE hList)
    17321735{
     
    17421745}
    17431746
     1747/** @copydoc SHCLTXPROVIDERIFACE::pfnListHdrRead */
    17441748static DECLCALLBACK(int) vbglR3ClipboardTransferIfaceListHdrRead(PSHCLTXPROVIDERCTX pCtx,
    17451749                                                                 SHCLLISTHANDLE hList, PSHCLLISTHDR pListHdr)
     
    17651769}
    17661770
     1771/** @copydoc SHCLTXPROVIDERIFACE::pfnListEntryRead */
    17671772static DECLCALLBACK(int) vbglR3ClipboardTransferIfaceListEntryRead(PSHCLTXPROVIDERCTX pCtx,
    17681773                                                                   SHCLLISTHANDLE hList, PSHCLLISTENTRY pEntry)
     
    17791784}
    17801785
     1786/** @copydoc SHCLTXPROVIDERIFACE::pfnObjOpen */
    17811787static DECLCALLBACK(int) vbglR3ClipboardTransferIfaceObjOpen(PSHCLTXPROVIDERCTX pCtx,
    17821788                                                             PSHCLOBJOPENCREATEPARMS pCreateParms, PSHCLOBJHANDLE phObj)
     
    17931799}
    17941800
     1801/** @copydoc SHCLTXPROVIDERIFACE::pfnObjClose */
    17951802static DECLCALLBACK(int) vbglR3ClipboardTransferIfaceObjClose(PSHCLTXPROVIDERCTX pCtx, SHCLOBJHANDLE hObj)
    17961803{
     
    18061813}
    18071814
     1815/** @copydoc SHCLTXPROVIDERIFACE::pfnObjRead */
    18081816static DECLCALLBACK(int) vbglR3ClipboardTransferIfaceObjRead(PSHCLTXPROVIDERCTX pCtx,
    18091817                                                             SHCLOBJHANDLE hObj, void *pvData, uint32_t cbData,
     
    18601868                if (enmDir == SHCLTRANSFERDIR_FROM_REMOTE)
    18611869                {
    1862                     creationCtx.Interface.pfnRootsGet      = vbglR3ClipboardTransferIfaceGetRoots;
     1870                    creationCtx.Interface.pfnRootsGet      = vbglR3ClipboardTransferIfaceRootsGet;
    18631871
    18641872                    creationCtx.Interface.pfnListOpen      = vbglR3ClipboardTransferIfaceListOpen;
  • trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-transfers.cpp

    r99951 r99954  
    9797*********************************************************************************************************************************/
    9898
     99/** @copydoc SHCLTXPROVIDERIFACE::pfnRootsGet */
    99100DECLCALLBACK(int) shClSvcTransferIfaceRootsGet(PSHCLTXPROVIDERCTX pCtx, PSHCLROOTLIST *ppRootList)
    100101{
     
    220221}
    221222
     223/** @copydoc SHCLTXPROVIDERIFACE::pfnListOpen */
    222224DECLCALLBACK(int) shClSvcTransferIfaceListOpen(PSHCLTXPROVIDERCTX pCtx,
    223225                                               PSHCLLISTOPENPARMS pOpenParms, PSHCLLISTHANDLE phList)
     
    281283}
    282284
     285/** @copydoc SHCLTXPROVIDERIFACE::pfnListClose */
    283286DECLCALLBACK(int) shClSvcTransferIfaceListClose(PSHCLTXPROVIDERCTX pCtx, SHCLLISTHANDLE hList)
    284287{
     
    328331}
    329332
     333/** @copydoc SHCLTXPROVIDERIFACE::pfnListHdrRead */
    330334DECLCALLBACK(int) shClSvcTransferIfaceListHdrRead(PSHCLTXPROVIDERCTX pCtx,
    331335                                                  SHCLLISTHANDLE hList, PSHCLLISTHDR pListHdr)
     
    380384}
    381385
     386/** @copydoc SHCLTXPROVIDERIFACE::pfnListHdrWrite */
    382387DECLCALLBACK(int) shClSvcTransferIfaceListHdrWrite(PSHCLTXPROVIDERCTX pCtx,
    383388                                                   SHCLLISTHANDLE hList, PSHCLLISTHDR pListHdr)
     
    390395}
    391396
     397/** @copydoc SHCLTXPROVIDERIFACE::pfnListEntryRead */
    392398DECLCALLBACK(int) shClSvcTransferIfaceListEntryRead(PSHCLTXPROVIDERCTX pCtx,
    393399                                                    SHCLLISTHANDLE hList, PSHCLLISTENTRY pListEntry)
     
    442448}
    443449
     450/** @copydoc SHCLTXPROVIDERIFACE::pfnListEntryWrite */
    444451DECLCALLBACK(int) shClSvcTransferIfaceListEntryWrite(PSHCLTXPROVIDERCTX pCtx,
    445452                                                     SHCLLISTHANDLE hList, PSHCLLISTENTRY pListEntry)
     
    452459}
    453460
     461/** @copydoc SHCLTXPROVIDERIFACE::pfnObjOpen */
    454462int shClSvcTransferIfaceObjOpen(PSHCLTXPROVIDERCTX pCtx, PSHCLOBJOPENCREATEPARMS pCreateParms,
    455463                                PSHCLOBJHANDLE phObj)
     
    517525}
    518526
     527/** @copydoc SHCLTXPROVIDERIFACE::pfnObjClose */
    519528int shClSvcTransferIfaceObjClose(PSHCLTXPROVIDERCTX pCtx, SHCLOBJHANDLE hObj)
    520529{
     
    572581}
    573582
     583/** @copydoc SHCLTXPROVIDERIFACE::pfnObjRead */
    574584int shClSvcTransferIfaceObjRead(PSHCLTXPROVIDERCTX pCtx, SHCLOBJHANDLE hObj,
    575585                                void *pvData, uint32_t cbData, uint32_t fFlags, uint32_t *pcbRead)
     
    633643}
    634644
     645/** @copydoc SHCLTXPROVIDERIFACE::pfnObjWrite */
    635646int shClSvcTransferIfaceObjWrite(PSHCLTXPROVIDERCTX pCtx, SHCLOBJHANDLE hObj,
    636647                                 void *pvData, uint32_t cbData, uint32_t fFlags, uint32_t *pcbWritten)
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