1 | /** @file
|
---|
2 | * IPRT Filesystem API.
|
---|
3 | */
|
---|
4 |
|
---|
5 | /*
|
---|
6 | * Copyright (C) 2012-2017 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 | * The contents of this file may alternatively be used under the terms
|
---|
17 | * of the Common Development and Distribution License Version 1.0
|
---|
18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
---|
19 | * VirtualBox OSE distribution, in which case the provisions of the
|
---|
20 | * CDDL are applicable instead of those of the GPL.
|
---|
21 | *
|
---|
22 | * You may elect to license modified versions of this file under the
|
---|
23 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
24 | */
|
---|
25 |
|
---|
26 | #ifndef ___iprt_filesystem_h
|
---|
27 | #define ___iprt_filesystem_h
|
---|
28 |
|
---|
29 | #include <iprt/cdefs.h>
|
---|
30 | #include <iprt/types.h>
|
---|
31 | #include <iprt/vfs.h>
|
---|
32 |
|
---|
33 | RT_C_DECLS_BEGIN
|
---|
34 |
|
---|
35 | /** @defgroup grp_rt_filesystem IPRT Filesystem VFS
|
---|
36 | *
|
---|
37 | * @todo r=bird: WRONG WRONG WRONG FILE. We already have a file system API in
|
---|
38 | * IPRT, it is RTFs*, see @ref grp_rt_fs. NOBODY ADDS ANY NEW APIS HERE!!
|
---|
39 | *
|
---|
40 | * @{
|
---|
41 | */
|
---|
42 |
|
---|
43 | /**
|
---|
44 | * Detect the filesystem in the image given by the VFS file handle
|
---|
45 | * and create a new VFS object.
|
---|
46 | *
|
---|
47 | * @returns IPRT status code.
|
---|
48 | * @retval VERR_NOT_SUPPORTED if the filesystem is not recognized.
|
---|
49 | * @param hVfsFile The file to use as the filesystem medium.
|
---|
50 | * @param phVfs Where to store the VFS handle on success.
|
---|
51 | */
|
---|
52 | RTDECL(int) RTFilesystemVfsFromFile(RTVFSFILE hVfsFile, PRTVFS phVfs);
|
---|
53 |
|
---|
54 | /** @} */
|
---|
55 |
|
---|
56 | RT_C_DECLS_END
|
---|
57 |
|
---|
58 | #endif /* !___iprt_filesystem_h */
|
---|
59 |
|
---|