VBoxGuestR3LibSharedFolders.cpp revision ba31bc205e96548d3557ae82087dc020a52b6a0a
a0b54ffecf8bb5bfb4f335cfa5deb6815c66e8b6vboxsync * VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions, shared folders.
c58f1213e628a545081c70e26c6b67a841cff880vboxsync * Copyright (C) 2010 Oracle Corporation
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * available from http://www.virtualbox.org. This file is free software;
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * you can redistribute it and/or modify it under the terms of the GNU
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * General Public License (GPL) as published by the Free Software
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * The contents of this file may alternatively be used under the terms
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * of the Common Development and Distribution License Version 1.0
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * VirtualBox OSE distribution, in which case the provisions of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * CDDL are applicable instead of those of the GPL.
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * You may elect to license modified versions of this file under the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * terms and conditions of either the GPL or the CDDL or both.
a0b54ffecf8bb5bfb4f335cfa5deb6815c66e8b6vboxsync/*******************************************************************************
a0b54ffecf8bb5bfb4f335cfa5deb6815c66e8b6vboxsync* Header Files *
a0b54ffecf8bb5bfb4f335cfa5deb6815c66e8b6vboxsync*******************************************************************************/
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync#include <VBox/shflsvc.h> /** @todo File should be moved to VBox/HostServices/SharedFolderSvc.h */
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync * Connects to the shared folder service.
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync * @returns VBox status code
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync * @param pu32ClientId Where to put the client id on success. The client id
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync * must be passed to all the other calls to the service.
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsyncVBGLR3DECL(int) VbglR3SharedFolderConnect(uint32_t *pu32ClientId)
4137127a66ddfcee9cba4a699988af6c27ad2720vboxsync strcpy(Info.Loc.u.host.achName, "VBoxSharedFolders");
4137127a66ddfcee9cba4a699988af6c27ad2720vboxsync Info.u32ClientID = UINT32_MAX; /* try make valgrid shut up. */
4137127a66ddfcee9cba4a699988af6c27ad2720vboxsync int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CONNECT, &Info, sizeof(Info));
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync * Disconnect from the shared folder service.
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync * @returns VBox status code.
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync * @param u32ClientId The client id returned by VbglR3InfoSvcConnect().
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsyncVBGLR3DECL(int) VbglR3SharedFolderDisconnect(uint32_t u32ClientId)
a0b54ffecf8bb5bfb4f335cfa5deb6815c66e8b6vboxsync int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_DISCONNECT, &Info, sizeof(Info));
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync * Get the list of available shared folders.
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync * @returns VBox status code.
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync * @param u32ClientId The client id returned by VbglR3SharedFolderConnect().
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync * @param fAutoMountOnly Flag whether only auto-mounted shared folders
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync * should be reported.
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync * @param ppaMappings Allocated array which will retrieve the mapping info. Needs
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync * to be freed with VbglR3SharedFolderFreeMappings() later.
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync * @param pcMappings The number of mappings returned in @a ppaMappings.
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsyncVBGLR3DECL(int) VbglR3SharedFolderGetMappings(uint32_t u32ClientId, bool fAutoMountOnly,
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync PVBGLR3SHAREDFOLDERMAPPING *ppaMappings, uint32_t *pcMappings)
4137127a66ddfcee9cba4a699988af6c27ad2720vboxsync /* Set the mapping flags. */
4137127a66ddfcee9cba4a699988af6c27ad2720vboxsync uint32_t u32Flags = 0; /** @todo SHFL_MF_UTF8 is not implemented yet. */
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync if (fAutoMountOnly) /* We only want the mappings which get auto-mounted. */
a0b54ffecf8bb5bfb4f335cfa5deb6815c66e8b6vboxsync * Prepare and get the actual mappings from the host service.
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync uint32_t cMappings = 8; /* Should be a good default value. */
a9dd9ab5c5c59b478410917e2091ec2d3349d3c7vboxsync uint32_t cbSize = cMappings * sizeof(VBGLR3SHAREDFOLDERMAPPING);
a0b54ffecf8bb5bfb4f335cfa5deb6815c66e8b6vboxsync VBGLR3SHAREDFOLDERMAPPING *ppaMappingsTemp = (PVBGLR3SHAREDFOLDERMAPPING)RTMemAllocZ(cbSize);
a0b54ffecf8bb5bfb4f335cfa5deb6815c66e8b6vboxsync VbglHGCMParmUInt32Set(&Msg.numberOfMappings, cMappings);
a0b54ffecf8bb5bfb4f335cfa5deb6815c66e8b6vboxsync VbglHGCMParmPtrSet(&Msg.mappings, ppaMappingsTemp, cbSize);
a0b54ffecf8bb5bfb4f335cfa5deb6815c66e8b6vboxsync rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CALL(sizeof(Msg)), &Msg, sizeof(Msg));
return rc;
int rc;
if (pString)
return rc;