VirtualBox

source: vbox/trunk/src/VBox/HostServices/SharedFolders/mappings.h@ 67954

Last change on this file since 67954 was 62489, checked in by vboxsync, 8 years ago

(C) 2016

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.2 KB
Line 
1/** @file
2 * Shared folders: Mappings header.
3 */
4
5/*
6 * Copyright (C) 2006-2016 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 */
16
17#ifndef ___MAPPINGS_H
18#define ___MAPPINGS_H
19
20#include "shfl.h"
21#include <VBox/shflsvc.h>
22
23typedef struct
24{
25 char *pszFolderName; /**< directory at the host to share with the guest */
26 PSHFLSTRING pMapName; /**< share name for the guest */
27 uint32_t cMappings; /**< number of mappings */
28 bool fValid; /**< mapping entry is used/valid */
29 bool fHostCaseSensitive; /**< host file name space is case-sensitive */
30 bool fGuestCaseSensitive; /**< guest file name space is case-sensitive */
31 bool fWritable; /**< folder is writable for the guest */
32 bool fAutoMount; /**< folder will be auto-mounted by the guest */
33 bool fSymlinksCreate; /**< guest is able to create symlinks */
34 bool fMissing; /**< mapping not invalid but host path does not exist.
35 Any guest operation on such a folder fails! */
36 bool fPlaceholder; /**< mapping does not exist in the VM settings but the guest
37 still has. fMissing is always true for this mapping. */
38} MAPPING;
39/** Pointer to a MAPPING structure. */
40typedef MAPPING *PMAPPING;
41
42void vbsfMappingInit(void);
43
44bool vbsfMappingQuery(uint32_t iMapping, PMAPPING *pMapping);
45
46int vbsfMappingsAdd(const char *pszFolderName, PSHFLSTRING pMapName,
47 bool fWritable, bool fAutoMount, bool fCreateSymlinks, bool fMissing, bool fPlaceholder);
48int vbsfMappingsRemove(PSHFLSTRING pMapName);
49
50int vbsfMappingsQuery(PSHFLCLIENTDATA pClient, PSHFLMAPPING pMappings, uint32_t *pcMappings);
51int vbsfMappingsQueryName(PSHFLCLIENTDATA pClient, SHFLROOT root, SHFLSTRING *pString);
52int vbsfMappingsQueryWritable(PSHFLCLIENTDATA pClient, SHFLROOT root, bool *fWritable);
53int vbsfMappingsQueryAutoMount(PSHFLCLIENTDATA pClient, SHFLROOT root, bool *fAutoMount);
54int vbsfMappingsQuerySymlinksCreate(PSHFLCLIENTDATA pClient, SHFLROOT root, bool *fSymlinksCreate);
55
56int vbsfMapFolder(PSHFLCLIENTDATA pClient, PSHFLSTRING pszMapName, RTUTF16 delimiter,
57 bool fCaseSensitive, SHFLROOT *pRoot);
58int vbsfUnmapFolder(PSHFLCLIENTDATA pClient, SHFLROOT root);
59
60const char* vbsfMappingsQueryHostRoot(SHFLROOT root);
61int vbsfMappingsQueryHostRootEx(SHFLROOT hRoot, const char **ppszRoot, uint32_t *pcbRootLen);
62bool vbsfIsGuestMappingCaseSensitive(SHFLROOT root);
63bool vbsfIsHostMappingCaseSensitive(SHFLROOT root);
64
65int vbsfMappingLoaded(const PMAPPING pLoadedMapping, SHFLROOT root);
66PMAPPING vbsfMappingGetByRoot(SHFLROOT root);
67
68#endif /* !___MAPPINGS_H */
69
Note: See TracBrowser for help on using the repository browser.

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