summaryrefslogtreecommitdiffstats
path: root/include/iprt/handle.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-06 03:01:46 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-06 03:01:46 +0000
commitf8fe689a81f906d1b91bb3220acde2a4ecb14c5b (patch)
tree26484e9d7e2c67806c2d1760196ff01aaa858e8c /include/iprt/handle.h
parentInitial commit. (diff)
downloadvirtualbox-f8fe689a81f906d1b91bb3220acde2a4ecb14c5b.tar.xz
virtualbox-f8fe689a81f906d1b91bb3220acde2a4ecb14c5b.zip
Adding upstream version 6.0.4-dfsg.upstream/6.0.4-dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'include/iprt/handle.h')
-rw-r--r--include/iprt/handle.h67
1 files changed, 67 insertions, 0 deletions
diff --git a/include/iprt/handle.h b/include/iprt/handle.h
new file mode 100644
index 00000000..304844f0
--- /dev/null
+++ b/include/iprt/handle.h
@@ -0,0 +1,67 @@
+/** @file
+ * IPRT - Generic Handle Operations.
+ */
+
+/*
+ * Copyright (C) 2010-2019 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_INCLUDED_handle_h
+#define IPRT_INCLUDED_handle_h
+#ifndef RT_WITHOUT_PRAGMA_ONCE
+# pragma once
+#endif
+
+#include <iprt/cdefs.h>
+#include <iprt/types.h>
+
+RT_C_DECLS_BEGIN
+
+/** @defgroup grp_rt_handle RTHandle - Generic Handle Operations
+ * @ingroup grp_rt
+ * @{
+ */
+
+/**
+ * Closes or destroy a generic handle.
+ *
+ * @returns IPRT status code.
+ * @param ph Pointer to the generic handle. The structure handle
+ * will be set to NIL. A NULL pointer or a NIL handle
+ * will be quietly ignore (VINF_SUCCESS).
+ */
+RTDECL(int) RTHandleClose(PRTHANDLE ph);
+
+/**
+ * Gets one of the standard handles.
+ *
+ * @returns IPRT status code.
+ * @param enmStdHandle The standard handle.
+ * @param ph Pointer to the generic handle. This will contain
+ * the most appropriate IPRT handle on success.
+ */
+RTDECL(int) RTHandleGetStandard(RTHANDLESTD enmStdHandle, PRTHANDLE ph);
+
+/** @} */
+
+RT_C_DECLS_END
+
+#endif /* !IPRT_INCLUDED_handle_h */
+