VirtualBox

Changeset 81223 in vbox for trunk/include/VBox/GuestHost


Ignore:
Timestamp:
Oct 11, 2019 12:06:49 PM (6 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
133910
Message:

Shared Clipboard/Transfers: Renaming.

Location:
trunk/include/VBox/GuestHost
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/VBox/GuestHost/SharedClipboard-transfers.h

    r81220 r81223  
    10331033} SHCLTRANSFERCTX, *PSHCLTRANSFERCTX;
    10341034
    1035 int SharedClipboardTransferObjCtxInit(PSHCLCLIENTTRANSFEROBJCTX pObjCtx);
    1036 void SharedClipboardTransferObjCtxDestroy(PSHCLCLIENTTRANSFEROBJCTX pObjCtx);
    1037 bool SharedClipboardTransferObjCtxIsValid(PSHCLCLIENTTRANSFEROBJCTX pObjCtx);
    1038 
    1039 int SharedClipboardTransferObjectHandleInfoInit(PSHCLOBJHANDLEINFO pInfo);
    1040 void SharedClipboardTransferObjectHandleInfoDestroy(PSHCLOBJHANDLEINFO pInfo);
    1041 
    1042 int SharedClipboardTransferObjectOpenParmsInit(PSHCLOBJOPENCREATEPARMS pParms);
    1043 int SharedClipboardTransferObjectOpenParmsCopy(PSHCLOBJOPENCREATEPARMS pParmsDst, PSHCLOBJOPENCREATEPARMS pParmsSrc);
    1044 void SharedClipboardTransferObjectOpenParmsDestroy(PSHCLOBJOPENCREATEPARMS pParms);
    1045 
    1046 int SharedClipboardTransferObjectOpen(PSHCLTRANSFER pTransfer, PSHCLOBJOPENCREATEPARMS pOpenCreateParms, PSHCLOBJHANDLE phObj);
    1047 int SharedClipboardTransferObjectClose(PSHCLTRANSFER pTransfer, SHCLOBJHANDLE hObj);
    1048 int SharedClipboardTransferObjectRead(PSHCLTRANSFER pTransfer, SHCLOBJHANDLE hObj, void *pvBuf, uint32_t cbBuf, uint32_t *pcbRead, uint32_t fFlags);
    1049 int SharedClipboardTransferObjectWrite(PSHCLTRANSFER pTransfer, SHCLOBJHANDLE hObj, void *pvBuf, uint32_t cbBuf, uint32_t *pcbWritten, uint32_t fFlags);
    1050 
    1051 PSHCLOBJDATACHUNK SharedClipboardTransferObjectDataChunkDup(PSHCLOBJDATACHUNK pDataChunk);
    1052 void SharedClipboardTransferObjectDataChunkDestroy(PSHCLOBJDATACHUNK pDataChunk);
    1053 void SharedClipboardTransferObjectDataChunkFree(PSHCLOBJDATACHUNK pDataChunk);
    1054 
    1055 int SharedClipboardTransferCreate(PSHCLTRANSFER *ppTransfer);
    1056 int SharedClipboardTransferDestroy(PSHCLTRANSFER pTransfer);
    1057 
    1058 int SharedClipboardTransferInit(PSHCLTRANSFER pTransfer, uint32_t uID, SHCLTRANSFERDIR enmDir, SHCLSOURCE enmSource);
    1059 int SharedClipboardTransferOpen(PSHCLTRANSFER pTransfer);
    1060 int SharedClipboardTransferClose(PSHCLTRANSFER pTransfer);
    1061 
    1062 int SharedClipboardTransferListOpen(PSHCLTRANSFER pTransfer, PSHCLLISTOPENPARMS pOpenParms, PSHCLLISTHANDLE phList);
    1063 int SharedClipboardTransferListClose(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList);
    1064 int SharedClipboardTransferListGetHeader(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, PSHCLLISTHDR pHdr);
    1065 PSHCLTRANSFEROBJ SharedClipboardTransferListGetObj(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, uint64_t uIdx);
    1066 int SharedClipboardTransferListRead(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, PSHCLLISTENTRY pEntry);
    1067 int SharedClipboardTransferListWrite(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, PSHCLLISTENTRY pEntry);
    1068 bool SharedClipboardTransferListHandleIsValid(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList);
    1069 
    1070 int SharedClipboardPathSanitizeFilename(char *pszPath, size_t cbPath);
    1071 int SharedClipboardPathSanitize(char *pszPath, size_t cbPath);
    1072 
    1073 PSHCLROOTLIST SharedClipboardTransferRootListAlloc(void);
    1074 void SharedClipboardTransferRootListFree(PSHCLROOTLIST pRootList);
    1075 
    1076 PSHCLROOTLISTHDR SharedClipboardTransferRootListHdrDup(PSHCLROOTLISTHDR pRoots);
    1077 int SharedClipboardTransferRootListHdrInit(PSHCLROOTLISTHDR pRoots);
    1078 void SharedClipboardTransferRootListHdrDestroy(PSHCLROOTLISTHDR pRoots);
    1079 
    1080 int SharedClipboardTransferRootListEntryCopy(PSHCLROOTLISTENTRY pDst, PSHCLROOTLISTENTRY pSrc);
    1081 int SharedClipboardTransferRootListEntryInit(PSHCLROOTLISTENTRY pRootListEntry);
    1082 void SharedClipboardTransferRootListEntryDestroy(PSHCLROOTLISTENTRY pRootListEntry);
    1083 PSHCLROOTLISTENTRY SharedClipboardTransferRootListEntryDup(PSHCLROOTLISTENTRY pRootListEntry);
    1084 
    1085 int SharedClipboardTransferListHandleInfoInit(PSHCLLISTHANDLEINFO pInfo);
    1086 void SharedClipboardTransferListHandleInfoDestroy(PSHCLLISTHANDLEINFO pInfo);
    1087 
    1088 int SharedClipboardTransferListHdrAlloc(PSHCLLISTHDR *ppListHdr);
    1089 void SharedClipboardTransferListHdrFree(PSHCLLISTHDR pListHdr);
     1035int ShClTransferObjCtxInit(PSHCLCLIENTTRANSFEROBJCTX pObjCtx);
     1036void ShClTransferObjCtxDestroy(PSHCLCLIENTTRANSFEROBJCTX pObjCtx);
     1037bool ShClTransferObjCtxIsValid(PSHCLCLIENTTRANSFEROBJCTX pObjCtx);
     1038
     1039int ShClTransferObjHandleInfoInit(PSHCLOBJHANDLEINFO pInfo);
     1040void ShClTransferObjHandleInfoDestroy(PSHCLOBJHANDLEINFO pInfo);
     1041
     1042int ShClTransferObjOpenParmsInit(PSHCLOBJOPENCREATEPARMS pParms);
     1043int ShClTransferObjOpenParmsCopy(PSHCLOBJOPENCREATEPARMS pParmsDst, PSHCLOBJOPENCREATEPARMS pParmsSrc);
     1044void ShClTransferObjOpenParmsDestroy(PSHCLOBJOPENCREATEPARMS pParms);
     1045
     1046int ShClTransferObjOpen(PSHCLTRANSFER pTransfer, PSHCLOBJOPENCREATEPARMS pOpenCreateParms, PSHCLOBJHANDLE phObj);
     1047int ShClTransferObjClose(PSHCLTRANSFER pTransfer, SHCLOBJHANDLE hObj);
     1048int ShClTransferObjRead(PSHCLTRANSFER pTransfer, SHCLOBJHANDLE hObj, void *pvBuf, uint32_t cbBuf, uint32_t *pcbRead, uint32_t fFlags);
     1049int ShClTransferObjWrite(PSHCLTRANSFER pTransfer, SHCLOBJHANDLE hObj, void *pvBuf, uint32_t cbBuf, uint32_t *pcbWritten, uint32_t fFlags);
     1050
     1051PSHCLOBJDATACHUNK ShClTransferObjDataChunkDup(PSHCLOBJDATACHUNK pDataChunk);
     1052void ShClTransferObjDataChunkDestroy(PSHCLOBJDATACHUNK pDataChunk);
     1053void ShClTransferObjDataChunkFree(PSHCLOBJDATACHUNK pDataChunk);
     1054
     1055int ShClTransferCreate(PSHCLTRANSFER *ppTransfer);
     1056int ShClTransferDestroy(PSHCLTRANSFER pTransfer);
     1057
     1058int ShClTransferInit(PSHCLTRANSFER pTransfer, uint32_t uID, SHCLTRANSFERDIR enmDir, SHCLSOURCE enmSource);
     1059int ShClTransferOpen(PSHCLTRANSFER pTransfer);
     1060int ShClTransferClose(PSHCLTRANSFER pTransfer);
     1061
     1062int ShClTransferListOpen(PSHCLTRANSFER pTransfer, PSHCLLISTOPENPARMS pOpenParms, PSHCLLISTHANDLE phList);
     1063int ShClTransferListClose(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList);
     1064int ShClTransferListGetHeader(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, PSHCLLISTHDR pHdr);
     1065PSHCLTRANSFEROBJ ShClTransferListGetObj(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, uint64_t uIdx);
     1066int ShClTransferListRead(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, PSHCLLISTENTRY pEntry);
     1067int ShClTransferListWrite(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, PSHCLLISTENTRY pEntry);
     1068bool ShClTransferListHandleIsValid(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList);
     1069
     1070int ShClPathSanitizeFilename(char *pszPath, size_t cbPath);
     1071int ShClPathSanitize(char *pszPath, size_t cbPath);
     1072
     1073PSHCLROOTLIST ShClTransferRootListAlloc(void);
     1074void ShClTransferRootListFree(PSHCLROOTLIST pRootList);
     1075
     1076PSHCLROOTLISTHDR ShClTransferRootListHdrDup(PSHCLROOTLISTHDR pRoots);
     1077int ShClTransferRootListHdrInit(PSHCLROOTLISTHDR pRoots);
     1078void ShClTransferRootListHdrDestroy(PSHCLROOTLISTHDR pRoots);
     1079
     1080int ShClTransferRootListEntryCopy(PSHCLROOTLISTENTRY pDst, PSHCLROOTLISTENTRY pSrc);
     1081int ShClTransferRootListEntryInit(PSHCLROOTLISTENTRY pRootListEntry);
     1082void ShClTransferRootListEntryDestroy(PSHCLROOTLISTENTRY pRootListEntry);
     1083PSHCLROOTLISTENTRY ShClTransferRootListEntryDup(PSHCLROOTLISTENTRY pRootListEntry);
     1084
     1085int ShClTransferListHandleInfoInit(PSHCLLISTHANDLEINFO pInfo);
     1086void ShClTransferListHandleInfoDestroy(PSHCLLISTHANDLEINFO pInfo);
     1087
     1088int ShClTransferListHdrAlloc(PSHCLLISTHDR *ppListHdr);
     1089void ShClTransferListHdrFree(PSHCLLISTHDR pListHdr);
    10901090PSHCLLISTHDR SharedClipboardTransferListHdrDup(PSHCLLISTHDR pListHdr);
    1091 int SharedClipboardTransferListHdrInit(PSHCLLISTHDR pListHdr);
    1092 void SharedClipboardTransferListHdrDestroy(PSHCLLISTHDR pListHdr);
    1093 void SharedClipboardTransferListHdrFree(PSHCLLISTHDR pListHdr);
    1094 void SharedClipboardTransferListHdrReset(PSHCLLISTHDR pListHdr);
    1095 bool SharedClipboardTransferListHdrIsValid(PSHCLLISTHDR pListHdr);
    1096 
    1097 int SharedClipboardTransferListOpenParmsCopy(PSHCLLISTOPENPARMS pDst, PSHCLLISTOPENPARMS pSrc);
    1098 PSHCLLISTOPENPARMS SharedClipboardTransferListOpenParmsDup(PSHCLLISTOPENPARMS pParms);
    1099 int SharedClipboardTransferListOpenParmsInit(PSHCLLISTOPENPARMS pParms);
    1100 void SharedClipboardTransferListOpenParmsDestroy(PSHCLLISTOPENPARMS pParms);
    1101 
    1102 int SharedClipboardTransferListEntryAlloc(PSHCLLISTENTRY *ppListEntry);
    1103 void SharedClipboardTransferListEntryFree(PSHCLLISTENTRY pListEntry);
    1104 int SharedClipboardTransferListEntryCopy(PSHCLLISTENTRY pDst, PSHCLLISTENTRY pSrc);
    1105 PSHCLLISTENTRY SharedClipboardTransferListEntryDup(PSHCLLISTENTRY pListEntry);
    1106 int SharedClipboardTransferListEntryInit(PSHCLLISTENTRY pListEntry);
    1107 void SharedClipboardTransferListEntryDestroy(PSHCLLISTENTRY pListEntry);
    1108 bool SharedClipboardTransferListEntryIsValid(PSHCLLISTENTRY pListEntry);
    1109 
    1110 int SharedClipboardTransferSetInterface(PSHCLTRANSFER pTransfer, PSHCLPROVIDERCREATIONCTX pCreationCtx);
    1111 int SharedClipboardTransferRootsSet(PSHCLTRANSFER pTransfer, const char *pszRoots, size_t cbRoots);
    1112 void SharedClipboardTransferReset(PSHCLTRANSFER pTransfer);
    1113 SharedClipboardArea *SharedClipboardTransferGetArea(PSHCLTRANSFER pTransfer);
    1114 
    1115 uint32_t SharedClipboardTransferRootsCount(PSHCLTRANSFER pTransfer);
    1116 int SharedClipboardTransferRootsEntry(PSHCLTRANSFER pTransfer, uint64_t uIndex, PSHCLROOTLISTENTRY pEntry);
    1117 int SharedClipboardTransferRootsGet(PSHCLTRANSFER pTransfer, PSHCLROOTLIST *ppRootList);
    1118 
    1119 SHCLTRANSFERID SharedClipboardTransferGetID(PSHCLTRANSFER pTransfer);
    1120 SHCLTRANSFERDIR SharedClipboardTransferGetDir(PSHCLTRANSFER pTransfer);
    1121 SHCLSOURCE SharedClipboardTransferGetSource(PSHCLTRANSFER pTransfer);
    1122 SHCLTRANSFERSTATUS SharedClipboardTransferGetStatus(PSHCLTRANSFER pTransfer);
    1123 int SharedClipboardTransferHandleReply(PSHCLTRANSFER pTransfer, PSHCLREPLY pReply);
    1124 int SharedClipboardTransferRun(PSHCLTRANSFER pTransfer, PFNRTTHREAD pfnThreadFunc, void *pvUser);
    1125 int SharedClipboardTransferStart(PSHCLTRANSFER pTransfer);
    1126 void SharedClipboardTransferSetCallbacks(PSHCLTRANSFER pTransfer, PSHCLTRANSFERCALLBACKS pCallbacks);
    1127 
    1128 int SharedClipboardTransferRead(PSHCLTRANSFER pTransfer);
    1129 int SharedClipboardTransferReadObjects(PSHCLTRANSFER pTransfer);
    1130 
    1131 int SharedClipboardTransferWrite(PSHCLTRANSFER pTransfer);
    1132 int SharedClipboardTransferWriteObjects(PSHCLTRANSFER pTransfer);
    1133 
    1134 int SharedClipboardTransferCtxInit(PSHCLTRANSFERCTX pTransferCtx);
    1135 void SharedClipboardTransferCtxDestroy(PSHCLTRANSFERCTX pTransferCtx);
    1136 void SharedClipboardTransferCtxReset(PSHCLTRANSFERCTX pTransferCtx);
    1137 PSHCLTRANSFER SharedClipboardTransferCtxGetTransfer(PSHCLTRANSFERCTX pTransferCtx, uint32_t uIdx);
    1138 uint32_t SharedClipboardTransferCtxGetRunningTransfers(PSHCLTRANSFERCTX pTransferCtx);
    1139 uint32_t SharedClipboardTransferCtxGetTotalTransfers(PSHCLTRANSFERCTX pTransferCtx);
    1140 void SharedClipboardTransferCtxCleanup(PSHCLTRANSFERCTX pTransferCtx);
    1141 bool SharedClipboardTransferCtxTransfersMaximumReached(PSHCLTRANSFERCTX pTransferCtx);
    1142 int SharedClipboardTransferCtxTransferRegister(PSHCLTRANSFERCTX pTransferCtx, PSHCLTRANSFER pTransfer, uint32_t *pidTransfer);
    1143 int SharedClipboardTransferCtxTransferRegisterByIndex(PSHCLTRANSFERCTX pTransferCtx, PSHCLTRANSFER pTransfer, uint32_t idTransfer);
    1144 int SharedClipboardTransferCtxTransferUnregister(PSHCLTRANSFERCTX pTransferCtx, uint32_t idTransfer);
    1145 
    1146 void SharedClipboardFsObjFromIPRT(PSHCLFSOBJINFO pDst, PCRTFSOBJINFO pSrc);
    1147 
    1148 bool SharedClipboardMIMEHasFileURLs(const char *pcszFormat, size_t cchFormatMax);
    1149 bool SharedClipboardMIMENeedsCache(const char *pcszFormat, size_t cchFormatMax);
    1150 
    1151 const char *VBoxShClTransferStatusToStr(SHCLTRANSFERSTATUS enmStatus);
     1091int ShClTransferListHdrInit(PSHCLLISTHDR pListHdr);
     1092void ShClTransferListHdrDestroy(PSHCLLISTHDR pListHdr);
     1093void ShClTransferListHdrReset(PSHCLLISTHDR pListHdr);
     1094bool ShClTransferListHdrIsValid(PSHCLLISTHDR pListHdr);
     1095
     1096int ShClTransferListOpenParmsCopy(PSHCLLISTOPENPARMS pDst, PSHCLLISTOPENPARMS pSrc);
     1097PSHCLLISTOPENPARMS ShClTransferListOpenParmsDup(PSHCLLISTOPENPARMS pParms);
     1098int ShClTransferListOpenParmsInit(PSHCLLISTOPENPARMS pParms);
     1099void ShClTransferListOpenParmsDestroy(PSHCLLISTOPENPARMS pParms);
     1100
     1101int ShClTransferListEntryAlloc(PSHCLLISTENTRY *ppListEntry);
     1102void ShClTransferListEntryFree(PSHCLLISTENTRY pListEntry);
     1103int ShClTransferListEntryCopy(PSHCLLISTENTRY pDst, PSHCLLISTENTRY pSrc);
     1104PSHCLLISTENTRY ShClTransferListEntryDup(PSHCLLISTENTRY pListEntry);
     1105int ShClTransferListEntryInit(PSHCLLISTENTRY pListEntry);
     1106void ShClTransferListEntryDestroy(PSHCLLISTENTRY pListEntry);
     1107bool ShClTransferListEntryIsValid(PSHCLLISTENTRY pListEntry);
     1108
     1109int ShClTransferSetInterface(PSHCLTRANSFER pTransfer, PSHCLPROVIDERCREATIONCTX pCreationCtx);
     1110int ShClTransferRootsSet(PSHCLTRANSFER pTransfer, const char *pszRoots, size_t cbRoots);
     1111void ShClTransferReset(PSHCLTRANSFER pTransfer);
     1112SharedClipboardArea *ShClTransferGetArea(PSHCLTRANSFER pTransfer);
     1113
     1114uint32_t ShClTransferRootsCount(PSHCLTRANSFER pTransfer);
     1115int ShClTransferRootsEntry(PSHCLTRANSFER pTransfer, uint64_t uIndex, PSHCLROOTLISTENTRY pEntry);
     1116int ShClTransferRootsGet(PSHCLTRANSFER pTransfer, PSHCLROOTLIST *ppRootList);
     1117
     1118SHCLTRANSFERID ShClTransferGetID(PSHCLTRANSFER pTransfer);
     1119SHCLTRANSFERDIR ShClTransferGetDir(PSHCLTRANSFER pTransfer);
     1120SHCLSOURCE ShClTransferGetSource(PSHCLTRANSFER pTransfer);
     1121SHCLTRANSFERSTATUS ShClTransferGetStatus(PSHCLTRANSFER pTransfer);
     1122int ShClTransferRun(PSHCLTRANSFER pTransfer, PFNRTTHREAD pfnThreadFunc, void *pvUser);
     1123int ShClTransferStart(PSHCLTRANSFER pTransfer);
     1124void ShClTransferSetCallbacks(PSHCLTRANSFER pTransfer, PSHCLTRANSFERCALLBACKS pCallbacks);
     1125
     1126int ShClTransferCtxInit(PSHCLTRANSFERCTX pTransferCtx);
     1127void ShClTransferCtxDestroy(PSHCLTRANSFERCTX pTransferCtx);
     1128void ShClTransferCtxReset(PSHCLTRANSFERCTX pTransferCtx);
     1129PSHCLTRANSFER ShClTransferCtxGetTransfer(PSHCLTRANSFERCTX pTransferCtx, uint32_t uIdx);
     1130uint32_t ShClTransferCtxGetRunningTransfers(PSHCLTRANSFERCTX pTransferCtx);
     1131uint32_t ShClTransferCtxGetTotalTransfers(PSHCLTRANSFERCTX pTransferCtx);
     1132void ShClTransferCtxCleanup(PSHCLTRANSFERCTX pTransferCtx);
     1133bool ShClTransferCtxTransfersMaximumReached(PSHCLTRANSFERCTX pTransferCtx);
     1134int ShClTransferCtxTransferRegister(PSHCLTRANSFERCTX pTransferCtx, PSHCLTRANSFER pTransfer, uint32_t *pidTransfer);
     1135int ShClTransferCtxTransferRegisterByIndex(PSHCLTRANSFERCTX pTransferCtx, PSHCLTRANSFER pTransfer, uint32_t idTransfer);
     1136int ShClTransferCtxTransferUnregister(PSHCLTRANSFERCTX pTransferCtx, uint32_t idTransfer);
     1137
     1138void ShClFsObjFromIPRT(PSHCLFSOBJINFO pDst, PCRTFSOBJINFO pSrc);
     1139
     1140bool ShClMIMEHasFileURLs(const char *pcszFormat, size_t cchFormatMax);
     1141bool ShClMIMENeedsCache(const char *pcszFormat, size_t cchFormatMax);
     1142
     1143const char *ShClTransferStatusToStr(SHCLTRANSFERSTATUS enmStatus);
    11521144
    11531145#endif /* !VBOX_INCLUDED_GuestHost_SharedClipboard_transfers_h */

  • trunk/include/VBox/GuestHost/SharedClipboard.h

    r81044 r81223  
    180180} SHCLEVENTSOURCE, *PSHCLEVENTSOURCE;
    181181
    182 int SharedClipboardPayloadAlloc(uint32_t uID, const void *pvData, uint32_t cbData,
    183                                 PSHCLEVENTPAYLOAD *ppPayload);
    184 void SharedClipboardPayloadFree(PSHCLEVENTPAYLOAD pPayload);
    185 
    186 int SharedClipboardEventSourceCreate(PSHCLEVENTSOURCE pSource, SHCLEVENTSOURCEID uID);
    187 void SharedClipboardEventSourceDestroy(PSHCLEVENTSOURCE pSource);
    188 
    189 SHCLEVENTID SharedClipboardEventIDGenerate(PSHCLEVENTSOURCE pSource);
    190 SHCLEVENTID SharedClipboardEventGetLast(PSHCLEVENTSOURCE pSource);
    191 int SharedClipboardEventRegister(PSHCLEVENTSOURCE pSource, SHCLEVENTID uID);
    192 int SharedClipboardEventUnregister(PSHCLEVENTSOURCE pSource, SHCLEVENTID uID);
    193 int SharedClipboardEventWait(PSHCLEVENTSOURCE pSource, SHCLEVENTID uID, RTMSINTERVAL uTimeoutMs,
    194                              PSHCLEVENTPAYLOAD* ppPayload);
    195 int SharedClipboardEventSignal(PSHCLEVENTSOURCE pSource, SHCLEVENTID uID, PSHCLEVENTPAYLOAD pPayload);
    196 void SharedClipboardEventPayloadDetach(PSHCLEVENTSOURCE pSource, SHCLEVENTID uID);
     182/** @name Shared Clipboard data payload functions.
     183 *  @{
     184 */
     185int ShClPayloadAlloc(uint32_t uID, const void *pvData, uint32_t cbData, PSHCLEVENTPAYLOAD *ppPayload);
     186void ShClPayloadFree(PSHCLEVENTPAYLOAD pPayload);
     187/** @} */
     188
     189/** @name Shared Clipboard event source functions.
     190 *  @{
     191 */
     192int ShClEventSourceCreate(PSHCLEVENTSOURCE pSource, SHCLEVENTSOURCEID uID);
     193void ShClEventSourceDestroy(PSHCLEVENTSOURCE pSource);
     194/** @} */
     195
     196/** @name Shared Clipboard event functions.
     197 *  @{
     198 */
     199SHCLEVENTID ShClEventIDGenerate(PSHCLEVENTSOURCE pSource);
     200SHCLEVENTID ShClEventGetLast(PSHCLEVENTSOURCE pSource);
     201int ShClEventRegister(PSHCLEVENTSOURCE pSource, SHCLEVENTID uID);
     202int ShClEventUnregister(PSHCLEVENTSOURCE pSource, SHCLEVENTID uID);
     203int ShClEventWait(PSHCLEVENTSOURCE pSource, SHCLEVENTID uID, RTMSINTERVAL uTimeoutMs, PSHCLEVENTPAYLOAD* ppPayload);
     204int ShClEventSignal(PSHCLEVENTSOURCE pSource, SHCLEVENTID uID, PSHCLEVENTPAYLOAD pPayload);
     205void ShClEventPayloadDetach(PSHCLEVENTSOURCE pSource, SHCLEVENTID uID);
     206/** @} */
    197207
    198208/**
    … …  
    225235typedef struct _CLIPREADCBREQ CLIPREADCBREQ;
    226236
    227 /* APIs exported by the X11 backend. */
     237/** @name Shared Clipboard APIs exported by the X11 backend.
     238 *  @{
     239 */
    228240extern CLIPBACKEND *ClipConstructX11(SHCLCONTEXT *pFrontend, bool fHeadless);
    229241extern void ClipDestructX11(CLIPBACKEND *pBackend);
    … …  
    232244extern int ClipAnnounceFormatToX11(CLIPBACKEND *pBackend, SHCLFORMATS vboxFormats);
    233245extern int ClipRequestDataFromX11(CLIPBACKEND *pBackend, SHCLFORMATS vboxFormat, CLIPREADCBREQ *pReq);
    234 
    235 /* APIs (as callbacks) exported by the X11/VBox frontend. */
     246/** @} */
     247
     248/** @name Shared Clipboard APIs (as callbacks) exported by the X11/VBox frontend.
     249 *  @{
     250 */
    236251extern DECLCALLBACK(int)  ClipRequestDataForX11Callback(SHCLCONTEXT *pCtx, uint32_t u32Format, void **ppv, uint32_t *pcb);
    237252extern DECLCALLBACK(void) ClipReportX11FormatsCallback(SHCLCONTEXT *pCtx, uint32_t u32Formats);
    238253extern DECLCALLBACK(void) ClipRequestFromX11CompleteCallback(SHCLCONTEXT *pCtx, int rc, CLIPREADCBREQ *pReq, void *pv, uint32_t cb);
     254/** @} */
    239255#endif /* !VBOX_INCLUDED_GuestHost_SharedClipboard_h */
    240256

  • trunk/include/VBox/GuestHost/clipboard-helper.h

    r80990 r81223  
    5757 * @param   pcwcDst  The length of the destination string in RTUTF16 units.
    5858 */
    59 int vboxClipboardUtf16GetWinSize(PRTUTF16 pwszSrc, size_t cwcSrc, size_t *pcwcDst);
     59int ShClUtf16GetWinSize(PRTUTF16 pwszSrc, size_t cwcSrc, size_t *pcwcDst);
    6060
    6161/**
    … …  
    7272 * @param   cwcDst   Size of the buffer for the converted text in RTUTF16 units.
    7373 */
    74 int vboxClipboardUtf16LinToWin(PRTUTF16 pwszSrc, size_t cwcSrc, PRTUTF16 pwszDst, size_t cwcDst);
     74int ShClUtf16LinToWin(PRTUTF16 pwszSrc, size_t cwcSrc, PRTUTF16 pwszDst, size_t cwcDst);
    7575
    7676/**
    … …  
    8484 * @retval  pcwcDst  The length of the destination string in RTUTF16 units.
    8585 */
    86 int vboxClipboardUtf16GetLinSize(PRTUTF16 pwszSrc, size_t cwcSrc, size_t *pcwcDst);
     86int ShClUtf16GetLinSize(PRTUTF16 pwszSrc, size_t cwcSrc, size_t *pcwcDst);
    8787
    8888/**
    … …  
    9898 *                   chars.
    9999 */
    100 int vboxClipboardUtf16WinToLin(PRTUTF16 pwszSrc, size_t cwcSrc, PRTUTF16 pwszDst, size_t cwcDst);
     100int ShClUtf16WinToLin(PRTUTF16 pwszSrc, size_t cwcSrc, PRTUTF16 pwszDst, size_t cwcDst);
    101101
    102102#pragma pack(1)
    … …  
    157157 *                        data in bytes.
    158158 */
    159 int vboxClipboardDibToBmp(const void *pvSrc, size_t cbSrc, void **ppvDst, size_t *pcbDst);
     159int ShClDibToBmp(const void *pvSrc, size_t cbSrc, void **ppvDst, size_t *pcbDst);
    160160
    161161/**
    … …  
    170170 * @param   pcbDst        Pointer to the size of the destination data in bytes
    171171 */
    172 int vboxClipboardBmpGetDib(const void *pvSrc, size_t cbSrc, const void **ppvDst, size_t *pcbDst);
     172int ShClBmpGetDib(const void *pvSrc, size_t cbSrc, const void **ppvDst, size_t *pcbDst);
    173173
    174174#ifdef LOG_ENABLED
    … …  
    180180 * @param   cbSrc               Size (in bytes) of HTML data to dump.
    181181 */
    182 int VBoxShClDbgDumpHtml(const char *pszSrc, size_t cbSrc);
     182int ShClDbgDumpHtml(const char *pszSrc, size_t cbSrc);
    183183
    184184/**
    … …  
    189189 * @param   u32Format           Clipboard format to use for dumping.
    190190 */
    191 void VBoxShClDbgDumpData(const void *pv, size_t cb, SHCLFORMAT u32Format);
     191void ShClDbgDumpData(const void *pv, size_t cb, SHCLFORMAT u32Format);
    192192#endif /* LOG_ENABLED */
    193193
    … …  
    198198 * @param   uFn                 The function to translate.
    199199 */
    200 const char *VBoxShClHostFunctionToStr(uint32_t uFn);
     200const char *ShClHostFunctionToStr(uint32_t uFn);
    201201
    202202/**
    … …  
    206206 * @param   uMsg                The message to translate.
    207207 */
    208 const char *VBoxShClHostMsgToStr(uint32_t uMsg);
     208const char *ShClHostMsgToStr(uint32_t uMsg);
    209209
    210210/**
    … …  
    214214 * @param   uMsg                The message to translate.
    215215 */
    216 const char *VBoxShClGuestMsgToStr(uint32_t uMsg);
     216const char *ShClGuestMsgToStr(uint32_t uMsg);
    217217
    218218#endif /* !VBOX_INCLUDED_GuestHost_clipboard_helper_h */
Note: See TracChangeset for help on using the changeset viewer.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette