Changeset 81223 in vbox for trunk/include/VBox/GuestHost/SharedClipboard-transfers.h
- Timestamp:
- Oct 11, 2019 12:06:49 PM (5 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/include/VBox/GuestHost/SharedClipboard-transfers.h
r81220 r81223 1033 1033 } SHCLTRANSFERCTX, *PSHCLTRANSFERCTX; 1034 1034 1035 int Sh aredClipboardTransferObjCtxInit(PSHCLCLIENTTRANSFEROBJCTX pObjCtx);1036 void Sh aredClipboardTransferObjCtxDestroy(PSHCLCLIENTTRANSFEROBJCTX pObjCtx);1037 bool Sh aredClipboardTransferObjCtxIsValid(PSHCLCLIENTTRANSFEROBJCTX pObjCtx);1038 1039 int Sh aredClipboardTransferObjectHandleInfoInit(PSHCLOBJHANDLEINFO pInfo);1040 void Sh aredClipboardTransferObjectHandleInfoDestroy(PSHCLOBJHANDLEINFO pInfo);1041 1042 int Sh aredClipboardTransferObjectOpenParmsInit(PSHCLOBJOPENCREATEPARMS pParms);1043 int Sh aredClipboardTransferObjectOpenParmsCopy(PSHCLOBJOPENCREATEPARMS pParmsDst, PSHCLOBJOPENCREATEPARMS pParmsSrc);1044 void Sh aredClipboardTransferObjectOpenParmsDestroy(PSHCLOBJOPENCREATEPARMS pParms);1045 1046 int Sh aredClipboardTransferObjectOpen(PSHCLTRANSFER pTransfer, PSHCLOBJOPENCREATEPARMS pOpenCreateParms, PSHCLOBJHANDLE phObj);1047 int Sh aredClipboardTransferObjectClose(PSHCLTRANSFER pTransfer, SHCLOBJHANDLE hObj);1048 int Sh aredClipboardTransferObjectRead(PSHCLTRANSFER pTransfer, SHCLOBJHANDLE hObj, void *pvBuf, uint32_t cbBuf, uint32_t *pcbRead, uint32_t fFlags);1049 int Sh aredClipboardTransferObjectWrite(PSHCLTRANSFER pTransfer, SHCLOBJHANDLE hObj, void *pvBuf, uint32_t cbBuf, uint32_t *pcbWritten, uint32_t fFlags);1050 1051 PSHCLOBJDATACHUNK Sh aredClipboardTransferObjectDataChunkDup(PSHCLOBJDATACHUNK pDataChunk);1052 void Sh aredClipboardTransferObjectDataChunkDestroy(PSHCLOBJDATACHUNK pDataChunk);1053 void Sh aredClipboardTransferObjectDataChunkFree(PSHCLOBJDATACHUNK pDataChunk);1054 1055 int Sh aredClipboardTransferCreate(PSHCLTRANSFER *ppTransfer);1056 int Sh aredClipboardTransferDestroy(PSHCLTRANSFER pTransfer);1057 1058 int Sh aredClipboardTransferInit(PSHCLTRANSFER pTransfer, uint32_t uID, SHCLTRANSFERDIR enmDir, SHCLSOURCE enmSource);1059 int Sh aredClipboardTransferOpen(PSHCLTRANSFER pTransfer);1060 int Sh aredClipboardTransferClose(PSHCLTRANSFER pTransfer);1061 1062 int Sh aredClipboardTransferListOpen(PSHCLTRANSFER pTransfer, PSHCLLISTOPENPARMS pOpenParms, PSHCLLISTHANDLE phList);1063 int Sh aredClipboardTransferListClose(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList);1064 int Sh aredClipboardTransferListGetHeader(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, PSHCLLISTHDR pHdr);1065 PSHCLTRANSFEROBJ Sh aredClipboardTransferListGetObj(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, uint64_t uIdx);1066 int Sh aredClipboardTransferListRead(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, PSHCLLISTENTRY pEntry);1067 int Sh aredClipboardTransferListWrite(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, PSHCLLISTENTRY pEntry);1068 bool Sh aredClipboardTransferListHandleIsValid(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList);1069 1070 int Sh aredClipboardPathSanitizeFilename(char *pszPath, size_t cbPath);1071 int Sh aredClipboardPathSanitize(char *pszPath, size_t cbPath);1072 1073 PSHCLROOTLIST Sh aredClipboardTransferRootListAlloc(void);1074 void Sh aredClipboardTransferRootListFree(PSHCLROOTLIST pRootList);1075 1076 PSHCLROOTLISTHDR Sh aredClipboardTransferRootListHdrDup(PSHCLROOTLISTHDR pRoots);1077 int Sh aredClipboardTransferRootListHdrInit(PSHCLROOTLISTHDR pRoots);1078 void Sh aredClipboardTransferRootListHdrDestroy(PSHCLROOTLISTHDR pRoots);1079 1080 int Sh aredClipboardTransferRootListEntryCopy(PSHCLROOTLISTENTRY pDst, PSHCLROOTLISTENTRY pSrc);1081 int Sh aredClipboardTransferRootListEntryInit(PSHCLROOTLISTENTRY pRootListEntry);1082 void Sh aredClipboardTransferRootListEntryDestroy(PSHCLROOTLISTENTRY pRootListEntry);1083 PSHCLROOTLISTENTRY Sh aredClipboardTransferRootListEntryDup(PSHCLROOTLISTENTRY pRootListEntry);1084 1085 int Sh aredClipboardTransferListHandleInfoInit(PSHCLLISTHANDLEINFO pInfo);1086 void Sh aredClipboardTransferListHandleInfoDestroy(PSHCLLISTHANDLEINFO pInfo);1087 1088 int Sh aredClipboardTransferListHdrAlloc(PSHCLLISTHDR *ppListHdr);1089 void Sh aredClipboardTransferListHdrFree(PSHCLLISTHDR pListHdr);1035 int ShClTransferObjCtxInit(PSHCLCLIENTTRANSFEROBJCTX pObjCtx); 1036 void ShClTransferObjCtxDestroy(PSHCLCLIENTTRANSFEROBJCTX pObjCtx); 1037 bool ShClTransferObjCtxIsValid(PSHCLCLIENTTRANSFEROBJCTX pObjCtx); 1038 1039 int ShClTransferObjHandleInfoInit(PSHCLOBJHANDLEINFO pInfo); 1040 void ShClTransferObjHandleInfoDestroy(PSHCLOBJHANDLEINFO pInfo); 1041 1042 int ShClTransferObjOpenParmsInit(PSHCLOBJOPENCREATEPARMS pParms); 1043 int ShClTransferObjOpenParmsCopy(PSHCLOBJOPENCREATEPARMS pParmsDst, PSHCLOBJOPENCREATEPARMS pParmsSrc); 1044 void ShClTransferObjOpenParmsDestroy(PSHCLOBJOPENCREATEPARMS pParms); 1045 1046 int ShClTransferObjOpen(PSHCLTRANSFER pTransfer, PSHCLOBJOPENCREATEPARMS pOpenCreateParms, PSHCLOBJHANDLE phObj); 1047 int ShClTransferObjClose(PSHCLTRANSFER pTransfer, SHCLOBJHANDLE hObj); 1048 int ShClTransferObjRead(PSHCLTRANSFER pTransfer, SHCLOBJHANDLE hObj, void *pvBuf, uint32_t cbBuf, uint32_t *pcbRead, uint32_t fFlags); 1049 int ShClTransferObjWrite(PSHCLTRANSFER pTransfer, SHCLOBJHANDLE hObj, void *pvBuf, uint32_t cbBuf, uint32_t *pcbWritten, uint32_t fFlags); 1050 1051 PSHCLOBJDATACHUNK ShClTransferObjDataChunkDup(PSHCLOBJDATACHUNK pDataChunk); 1052 void ShClTransferObjDataChunkDestroy(PSHCLOBJDATACHUNK pDataChunk); 1053 void ShClTransferObjDataChunkFree(PSHCLOBJDATACHUNK pDataChunk); 1054 1055 int ShClTransferCreate(PSHCLTRANSFER *ppTransfer); 1056 int ShClTransferDestroy(PSHCLTRANSFER pTransfer); 1057 1058 int ShClTransferInit(PSHCLTRANSFER pTransfer, uint32_t uID, SHCLTRANSFERDIR enmDir, SHCLSOURCE enmSource); 1059 int ShClTransferOpen(PSHCLTRANSFER pTransfer); 1060 int ShClTransferClose(PSHCLTRANSFER pTransfer); 1061 1062 int ShClTransferListOpen(PSHCLTRANSFER pTransfer, PSHCLLISTOPENPARMS pOpenParms, PSHCLLISTHANDLE phList); 1063 int ShClTransferListClose(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList); 1064 int ShClTransferListGetHeader(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, PSHCLLISTHDR pHdr); 1065 PSHCLTRANSFEROBJ ShClTransferListGetObj(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, uint64_t uIdx); 1066 int ShClTransferListRead(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, PSHCLLISTENTRY pEntry); 1067 int ShClTransferListWrite(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, PSHCLLISTENTRY pEntry); 1068 bool ShClTransferListHandleIsValid(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList); 1069 1070 int ShClPathSanitizeFilename(char *pszPath, size_t cbPath); 1071 int ShClPathSanitize(char *pszPath, size_t cbPath); 1072 1073 PSHCLROOTLIST ShClTransferRootListAlloc(void); 1074 void ShClTransferRootListFree(PSHCLROOTLIST pRootList); 1075 1076 PSHCLROOTLISTHDR ShClTransferRootListHdrDup(PSHCLROOTLISTHDR pRoots); 1077 int ShClTransferRootListHdrInit(PSHCLROOTLISTHDR pRoots); 1078 void ShClTransferRootListHdrDestroy(PSHCLROOTLISTHDR pRoots); 1079 1080 int ShClTransferRootListEntryCopy(PSHCLROOTLISTENTRY pDst, PSHCLROOTLISTENTRY pSrc); 1081 int ShClTransferRootListEntryInit(PSHCLROOTLISTENTRY pRootListEntry); 1082 void ShClTransferRootListEntryDestroy(PSHCLROOTLISTENTRY pRootListEntry); 1083 PSHCLROOTLISTENTRY ShClTransferRootListEntryDup(PSHCLROOTLISTENTRY pRootListEntry); 1084 1085 int ShClTransferListHandleInfoInit(PSHCLLISTHANDLEINFO pInfo); 1086 void ShClTransferListHandleInfoDestroy(PSHCLLISTHANDLEINFO pInfo); 1087 1088 int ShClTransferListHdrAlloc(PSHCLLISTHDR *ppListHdr); 1089 void ShClTransferListHdrFree(PSHCLLISTHDR pListHdr); 1090 1090 PSHCLLISTHDR 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); 1091 int ShClTransferListHdrInit(PSHCLLISTHDR pListHdr); 1092 void ShClTransferListHdrDestroy(PSHCLLISTHDR pListHdr); 1093 void ShClTransferListHdrReset(PSHCLLISTHDR pListHdr); 1094 bool ShClTransferListHdrIsValid(PSHCLLISTHDR pListHdr); 1095 1096 int ShClTransferListOpenParmsCopy(PSHCLLISTOPENPARMS pDst, PSHCLLISTOPENPARMS pSrc); 1097 PSHCLLISTOPENPARMS ShClTransferListOpenParmsDup(PSHCLLISTOPENPARMS pParms); 1098 int ShClTransferListOpenParmsInit(PSHCLLISTOPENPARMS pParms); 1099 void ShClTransferListOpenParmsDestroy(PSHCLLISTOPENPARMS pParms); 1100 1101 int ShClTransferListEntryAlloc(PSHCLLISTENTRY *ppListEntry); 1102 void ShClTransferListEntryFree(PSHCLLISTENTRY pListEntry); 1103 int ShClTransferListEntryCopy(PSHCLLISTENTRY pDst, PSHCLLISTENTRY pSrc); 1104 PSHCLLISTENTRY ShClTransferListEntryDup(PSHCLLISTENTRY pListEntry); 1105 int ShClTransferListEntryInit(PSHCLLISTENTRY pListEntry); 1106 void ShClTransferListEntryDestroy(PSHCLLISTENTRY pListEntry); 1107 bool ShClTransferListEntryIsValid(PSHCLLISTENTRY pListEntry); 1108 1109 int ShClTransferSetInterface(PSHCLTRANSFER pTransfer, PSHCLPROVIDERCREATIONCTX pCreationCtx); 1110 int ShClTransferRootsSet(PSHCLTRANSFER pTransfer, const char *pszRoots, size_t cbRoots); 1111 void ShClTransferReset(PSHCLTRANSFER pTransfer); 1112 SharedClipboardArea *ShClTransferGetArea(PSHCLTRANSFER pTransfer); 1113 1114 uint32_t ShClTransferRootsCount(PSHCLTRANSFER pTransfer); 1115 int ShClTransferRootsEntry(PSHCLTRANSFER pTransfer, uint64_t uIndex, PSHCLROOTLISTENTRY pEntry); 1116 int ShClTransferRootsGet(PSHCLTRANSFER pTransfer, PSHCLROOTLIST *ppRootList); 1117 1118 SHCLTRANSFERID ShClTransferGetID(PSHCLTRANSFER pTransfer); 1119 SHCLTRANSFERDIR ShClTransferGetDir(PSHCLTRANSFER pTransfer); 1120 SHCLSOURCE ShClTransferGetSource(PSHCLTRANSFER pTransfer); 1121 SHCLTRANSFERSTATUS ShClTransferGetStatus(PSHCLTRANSFER pTransfer); 1122 int ShClTransferRun(PSHCLTRANSFER pTransfer, PFNRTTHREAD pfnThreadFunc, void *pvUser); 1123 int ShClTransferStart(PSHCLTRANSFER pTransfer); 1124 void ShClTransferSetCallbacks(PSHCLTRANSFER pTransfer, PSHCLTRANSFERCALLBACKS pCallbacks); 1125 1126 int ShClTransferCtxInit(PSHCLTRANSFERCTX pTransferCtx); 1127 void ShClTransferCtxDestroy(PSHCLTRANSFERCTX pTransferCtx); 1128 void ShClTransferCtxReset(PSHCLTRANSFERCTX pTransferCtx); 1129 PSHCLTRANSFER ShClTransferCtxGetTransfer(PSHCLTRANSFERCTX pTransferCtx, uint32_t uIdx); 1130 uint32_t ShClTransferCtxGetRunningTransfers(PSHCLTRANSFERCTX pTransferCtx); 1131 uint32_t ShClTransferCtxGetTotalTransfers(PSHCLTRANSFERCTX pTransferCtx); 1132 void ShClTransferCtxCleanup(PSHCLTRANSFERCTX pTransferCtx); 1133 bool ShClTransferCtxTransfersMaximumReached(PSHCLTRANSFERCTX pTransferCtx); 1134 int ShClTransferCtxTransferRegister(PSHCLTRANSFERCTX pTransferCtx, PSHCLTRANSFER pTransfer, uint32_t *pidTransfer); 1135 int ShClTransferCtxTransferRegisterByIndex(PSHCLTRANSFERCTX pTransferCtx, PSHCLTRANSFER pTransfer, uint32_t idTransfer); 1136 int ShClTransferCtxTransferUnregister(PSHCLTRANSFERCTX pTransferCtx, uint32_t idTransfer); 1137 1138 void ShClFsObjFromIPRT(PSHCLFSOBJINFO pDst, PCRTFSOBJINFO pSrc); 1139 1140 bool ShClMIMEHasFileURLs(const char *pcszFormat, size_t cchFormatMax); 1141 bool ShClMIMENeedsCache(const char *pcszFormat, size_t cchFormatMax); 1142 1143 const char *ShClTransferStatusToStr(SHCLTRANSFERSTATUS enmStatus); 1152 1144 1153 1145 #endif /* !VBOX_INCLUDED_GuestHost_SharedClipboard_transfers_h */
Note:
See TracChangeset
for help on using the changeset viewer.