summaryrefslogtreecommitdiff
path: root/include/iprt/filesystem.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/iprt/filesystem.h')
-rw-r--r--include/iprt/filesystem.h55
1 files changed, 55 insertions, 0 deletions
diff --git a/include/iprt/filesystem.h b/include/iprt/filesystem.h
new file mode 100644
index 00000000..82ab146e
--- /dev/null
+++ b/include/iprt/filesystem.h
@@ -0,0 +1,55 @@
+/** @file
+ * IPRT Filesystem API.
+ */
+
+/*
+ * Copyright (C) 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.
+ *
+ * The contents of this file may alternatively be used under the terms
+ * of the Common Development and Distribution License Version 1.0
+ * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
+ * VirtualBox OSE distribution, in which case the provisions of the
+ * CDDL are applicable instead of those of the GPL.
+ *
+ * You may elect to license modified versions of this file under the
+ * terms and conditions of either the GPL or the CDDL or both.
+ */
+
+#ifndef ___iprt_filesystem_h
+#define ___iprt_filesystem_h
+
+#include <iprt/cdefs.h>
+#include <iprt/types.h>
+#include <iprt/vfs.h>
+
+RT_C_DECLS_BEGIN
+
+/** @defgroup grp_filesystem IPRT Filesystem VFS
+ * @{
+ */
+
+/**
+ * Detect the filesystem in the image given by the VFS file handle
+ * and create a new VFS object.
+ *
+ * @returns IPRT status code.
+ * @retval VERR_NOT_SUPPORTED if the filesystem is not recognized.
+ * @param hVfsFile The file to use as the filesystem medium.
+ * @param phVfs Where to store the VFS handle on success.
+ */
+RTDECL(int) RTFilesystemVfsFromFile(RTVFSFILE hVfsFile, PRTVFS phVfs);
+
+/** @} */
+
+RT_C_DECLS_END
+
+#endif /* !___iprt_filesystem_h */
+