ubuntu/vbox/include/VBox/VBoxGuestLibSharedFolders.h

   1 /* $Id: VBoxGuestLibSharedFolders.h $ */
   2 /** @file
   3  * VBoxGuestLib - Central calls header.
   4  */
   5
   6 /*
   7  * Copyright (C) 2006-2016 Oracle Corporation
   8  *
   9  * This file is part of VirtualBox Open Source Edition (OSE), as
  10  * available from http://www.virtualbox.org. This file is free software;
  11  * you can redistribute it and/or modify it under the terms of the GNU
  12  * General Public License (GPL) as published by the Free Software
  13  * Foundation, in version 2 as it comes in the "COPYING" file of the
  14  * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
  15  * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
  16  *
  17  * The contents of this file may alternatively be used under the terms
  18  * of the Common Development and Distribution License Version 1.0
  19  * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
  20  * VirtualBox OSE distribution, in which case the provisions of the
  21  * CDDL are applicable instead of those of the GPL.
  22  *
  23  * You may elect to license modified versions of this file under the
  24  * terms and conditions of either the GPL or the CDDL or both.
  25  */
  26
  27 #ifndef ___VBox_VBoxGuestLibSharedFolders_h_
  28 #define ___VBox_VBoxGuestLibSharedFolders_h_
  29
  30 #include <VBox/VBoxGuestLib.h>
  31 #include <VBox/shflsvc.h>
  32
  33 RT_C_DECLS_BEGIN
  34
  35
  36 /** @addtogroup grp_vboxguest_lib_r0
  37  * @{
  38  */
  39
  40 typedef struct VBGLSFCLIENT
  41 {
  42     HGCMCLIENTID idClient;
  43     VBGLHGCMHANDLE handle;
  44 } VBGLSFCLIENT;
  45 typedef VBGLSFCLIENT *PVBGLSFCLIENT;
  46
  47 typedef struct VBGLSFMAP
  48 {
  49     SHFLROOT root;
  50 } VBGLSFMAP, *PVBGLSFMAP;
  51
  52 DECLVBGL(int)  VbglR0SfInit(void);
  53 DECLVBGL(void) VbglR0SfTerm(void);
  54 DECLVBGL(int)  VbglR0SfConnect(PVBGLSFCLIENT pClient);
  55 DECLVBGL(void) VbglR0SfDisconnect(PVBGLSFCLIENT pClient);
  56
  57 DECLVBGL(int)  VbglR0SfQueryMappings(PVBGLSFCLIENT pClient, SHFLMAPPING paMappings[], uint32_t *pcMappings);
  58
  59 DECLVBGL(int)  VbglR0SfQueryMapName(PVBGLSFCLIENT pClient, SHFLROOT root, SHFLSTRING *pString, uint32_t size);
  60
  61 /**
  62  * Create a new file or folder or open an existing one in a shared folder.  Proxies
  63  * to vbsfCreate in the host shared folder service.
  64  *
  65  * @returns IPRT status code, but see note below
  66  * @param   pClient      Host-guest communication connection
  67  * @param   pMap         The mapping for the shared folder in which the file
  68  *                       or folder is to be created
  69  * @param   pParsedPath  The path of the file or folder relative to the shared
  70  *                       folder
  71  * @param   pCreateParms Parameters for file/folder creation.  See the
  72  *                       structure description in shflsvc.h
  73  * @retval  pCreateParms See the structure description in shflsvc.h
  74  *
  75  * @note This function reports errors as follows.  The return value is always
  76  *       VINF_SUCCESS unless an exceptional condition occurs - out of
  77  *       memory, invalid arguments, etc.  If the file or folder could not be
  78  *       opened or created, pCreateParms->Handle will be set to
  79  *       SHFL_HANDLE_NIL on return.  In this case the value in
  80  *       pCreateParms->Result provides information as to why (e.g.
  81  *       SHFL_FILE_EXISTS).  pCreateParms->Result is also set on success
  82  *       as additional information.
  83  */
  84 DECLVBGL(int)  VbglR0SfCreate(PVBGLSFCLIENT pClient, PVBGLSFMAP pMap, PSHFLSTRING pParsedPath, PSHFLCREATEPARMS pCreateParms);
  85
  86 DECLVBGL(int)  VbglR0SfClose(PVBGLSFCLIENT pClient, PVBGLSFMAP pMap, SHFLHANDLE Handle);
  87 DECLVBGL(int)  VbglR0SfRemove(PVBGLSFCLIENT pClient, PVBGLSFMAP pMap, PSHFLSTRING pParsedPath, uint32_t flags);
  88 DECLVBGL(int)  VbglR0SfRename(PVBGLSFCLIENT pClient, PVBGLSFMAP pMap, PSHFLSTRING pSrcPath, PSHFLSTRING pDestPath, uint32_t flags);
  89 DECLVBGL(int)  VbglR0SfFlush(PVBGLSFCLIENT pClient, PVBGLSFMAP pMap, SHFLHANDLE hFile);
  90
  91 DECLVBGL(int)  VbglR0SfRead(PVBGLSFCLIENT pClient, PVBGLSFMAP pMap, SHFLHANDLE hFile, uint64_t offset, uint32_t *pcbBuffer, uint8_t *pBuffer, bool fLocked);
  92 DECLVBGL(int)  VbglR0SfReadPageList(PVBGLSFCLIENT pClient, PVBGLSFMAP pMap, SHFLHANDLE hFile, uint64_t offset, uint32_t *pcbBuffer,
  93                                     uint16_t offFirstPage, uint16_t cPages, RTGCPHYS64 *paPages);
  94 DECLVBGL(int)  VbglR0SfWrite(PVBGLSFCLIENT pClient, PVBGLSFMAP pMap, SHFLHANDLE hFile, uint64_t offset,
  95                              uint32_t *pcbBuffer,  uint8_t *pBuffer, bool fLocked);
  96 DECLVBGL(int)  VbglR0SfWritePhysCont(PVBGLSFCLIENT pClient, PVBGLSFMAP pMap, SHFLHANDLE hFile, uint64_t offset,
  97                                      uint32_t *pcbBuffer, RTCCPHYS PhysBuffer);
  98 DECLVBGL(int)  VbglR0SfWritePageList(PVBGLSFCLIENT pClient, PVBGLSFMAP pMap, SHFLHANDLE hFile, uint64_t offset, uint32_t *pcbBuffer,
  99                                      uint16_t offFirstPage, uint16_t cPages, RTGCPHYS64 *paPages);
 100
 101 DECLVBGL(int)  VbglR0SfLock(PVBGLSFCLIENT pClient, PVBGLSFMAP pMap, SHFLHANDLE hFile, uint64_t offset, uint64_t cbSize, uint32_t fLock);
 102
 103 DECLVBGL(int)  VbglR0SfDirInfo(PVBGLSFCLIENT pClient, PVBGLSFMAP pMap, SHFLHANDLE hFile,PSHFLSTRING ParsedPath, uint32_t flags,
 104                                uint32_t index, uint32_t *pcbBuffer, PSHFLDIRINFO pBuffer, uint32_t *pcFiles);
 105 DECLVBGL(int)  VbglR0SfFsInfo(PVBGLSFCLIENT pClient, PVBGLSFMAP pMap, SHFLHANDLE hFile, uint32_t flags, uint32_t *pcbBuffer, PSHFLDIRINFO pBuffer);
 106
 107 DECLVBGL(int)  VbglR0SfMapFolder(PVBGLSFCLIENT pClient, PSHFLSTRING szFolderName, PVBGLSFMAP pMap);
 108 DECLVBGL(int)  VbglR0SfUnmapFolder(PVBGLSFCLIENT pClient, PVBGLSFMAP pMap);
 109 DECLVBGL(int)  VbglR0SfSetUtf8(PVBGLSFCLIENT pClient);
 110
 111 DECLVBGL(int)  VbglR0SfReadLink(PVBGLSFCLIENT pClient, PVBGLSFMAP pMap, PSHFLSTRING ParsedPath, uint32_t pcbBuffer, uint8_t *pBuffer);
 112 DECLVBGL(int)  VbglR0SfSymlink(PVBGLSFCLIENT pClient, PVBGLSFMAP pMap, PSHFLSTRING pNewPath, PSHFLSTRING pOldPath, PSHFLFSOBJINFO pBuffer);
 113 DECLVBGL(int)  VbglR0SfSetSymlinks(PVBGLSFCLIENT pClient);
 114
 115 /** @} */
 116
 117 RT_C_DECLS_END
 118
 119 #endif
 120