VirtualBox

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

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

SharedFolders: fixed regression with Windows extended-length paths.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.9 KB
Line 
1/** @file
2 * VBox Shared Folders header.
3 * Guest/host path convertion and verification.
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
18#ifndef __VBSFPATH__H
19#define __VBSFPATH__H
20
21#include "shfl.h"
22#include <VBox/shflsvc.h>
23
24#define VBSF_O_PATH_WILDCARD UINT32_C(0x00000001)
25#define VBSF_O_PATH_PRESERVE_LAST_COMPONENT UINT32_C(0x00000002)
26#define VBSF_O_PATH_CHECK_ROOT_ESCAPE UINT32_C(0x00000004)
27
28#define VBSF_F_PATH_HAS_WILDCARD_IN_PREFIX UINT32_C(0x00000001) /* A component before the last one contains a wildcard. */
29#define VBSF_F_PATH_HAS_WILDCARD_IN_LAST UINT32_C(0x00000002) /* The last component contains a wildcard. */
30
31/**
32 *
33 * @param pClient Shared folder client.
34 * @param hRoot Root handle.
35 * @param pGuestString Guest want to access the path.
36 * @param cbGuestString Size of pGuestString memory buffer.
37 * @param ppszHostPath Returned full host path: root prefix + guest path.
38 * @param pcbHostPathRoot Length of the root prefix in bytes. Optional, can be NULL.
39 * @param fu32Options Options.
40 * @param pfu32PathFlags VBSF_F_PATH_* flags. Optional, can be NULL.
41 */
42int vbsfPathGuestToHost(SHFLCLIENTDATA *pClient, SHFLROOT hRoot,
43 PSHFLSTRING pGuestString, uint32_t cbGuestString,
44 char **ppszHostPath, uint32_t *pcbHostPathRoot,
45 uint32_t fu32Options, uint32_t *pfu32PathFlags);
46
47/** Free the host path returned by vbsfPathGuestToHost.
48 *
49 * @param pszHostPath Host path string.
50 */
51void vbsfFreeHostPath(char *pszHostPath);
52
53/**
54 * Build the absolute path by combining an absolute pszRoot and a relative pszPath.
55 * The resulting path does not contain '.' and '..' components.
56 * Similar to RTPathAbsEx but with support for Windows extended-length paths ("\\?\" prefix).
57 * Uses RTPathAbsEx for regular paths and on non-Windows hosts.
58 *
59 * @param pszRoot The absolute prefix. It is copied to the pszAbsPath without any processing.
60 * If NULL then the pszPath must be converted to the absolute path.
61 * @param pszPath The relative path to be appended to pszRoot. Already has correct delimiters (RTPATH_SLASH).
62 * @param pszAbsPath Where to store the resulting absolute path.
63 * @param cbAbsPath Size of pszAbsBuffer in bytes.
64 */
65int vbsfPathAbs(const char *pszRoot, const char *pszPath, char *pszAbsPath, size_t cbAbsPath);
66
67#endif /* __VBSFPATH__H */
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