mappings.h revision c58f1213e628a545081c70e26c6b67a841cff880
/** @file
* Shared folders: Mappings header.
*/
/*
* Copyright (C) 2006-2012 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
#ifndef ___MAPPINGS_H
#define ___MAPPINGS_H
#include "shfl.h"
#include <VBox/shflsvc.h>
typedef struct
{
char *pszFolderName; /**< directory at the host to share with the guest */
PSHFLSTRING pMapName; /**< share name for the guest */
uint32_t cMappings; /**< number of mappings */
bool fValid; /**< mapping entry is used/valid */
bool fHostCaseSensitive; /**< host file name space is case-sensitive */
bool fGuestCaseSensitive; /**< guest file name space is case-sensitive */
bool fWritable; /**< folder is writable for the guest */
bool fAutoMount; /**< folder will be auto-mounted by the guest */
bool fSymlinksCreate; /**< guest is able to create symlinks */
bool fMissing; /**< mapping not invalid but host path does not exist.
Any guest operation on such a folder fails! */
} MAPPING;
/** Pointer to a MAPPING structure. */
typedef MAPPING *PMAPPING;
void vbsfMappingInit(void);
bool vbsfMappingQuery(uint32_t iMapping, PMAPPING *pMapping);
int vbsfMappingsAdd(PSHFLSTRING pFolderName, PSHFLSTRING pMapName,
bool fWritable, bool fAutoMount, bool fCreateSymlinks, bool fMissing);
int vbsfMappingsRemove(PSHFLSTRING pMapName);
int vbsfMappingsQuery(PSHFLCLIENTDATA pClient, PSHFLMAPPING pMappings, uint32_t *pcMappings);
int vbsfMappingsQueryName(PSHFLCLIENTDATA pClient, SHFLROOT root, SHFLSTRING *pString);
int vbsfMappingsQueryWritable(PSHFLCLIENTDATA pClient, SHFLROOT root, bool *fWritable);
int vbsfMappingsQueryAutoMount(PSHFLCLIENTDATA pClient, SHFLROOT root, bool *fAutoMount);
int vbsfMappingsQuerySymlinksCreate(PSHFLCLIENTDATA pClient, SHFLROOT root, bool *fSymlinksCreate);
int vbsfMapFolder(PSHFLCLIENTDATA pClient, PSHFLSTRING pszMapName, RTUTF16 delimiter,
bool fCaseSensitive, SHFLROOT *pRoot);
int vbsfUnmapFolder(PSHFLCLIENTDATA pClient, SHFLROOT root);
const char* vbsfMappingsQueryHostRoot(SHFLROOT root);
bool vbsfIsGuestMappingCaseSensitive(SHFLROOT root);
bool vbsfIsHostMappingCaseSensitive(SHFLROOT root);
int vbsfMappingLoaded(const PMAPPING pLoadedMapping, SHFLROOT root);
PMAPPING vbsfMappingGetByRoot(SHFLROOT root);
#endif /* !___MAPPINGS_H */