VirtualBox

source: vbox/trunk/include/iprt/handle.h@ 100997

Last change on this file since 100997 was 98103, checked in by vboxsync, 23 months ago

Copyright year updates by scm.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.6 KB
Line 
1/** @file
2 * IPRT - Generic Handle Operations.
3 */
4
5/*
6 * Copyright (C) 2010-2023 Oracle and/or its affiliates.
7 *
8 * This file is part of VirtualBox base platform packages, as
9 * available from https://www.virtualbox.org.
10 *
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation, in version 3 of the
14 * License.
15 *
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, see <https://www.gnu.org/licenses>.
23 *
24 * The contents of this file may alternatively be used under the terms
25 * of the Common Development and Distribution License Version 1.0
26 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
27 * in the VirtualBox distribution, in which case the provisions of the
28 * CDDL are applicable instead of those of the GPL.
29 *
30 * You may elect to license modified versions of this file under the
31 * terms and conditions of either the GPL or the CDDL or both.
32 *
33 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
34 */
35
36#ifndef IPRT_INCLUDED_handle_h
37#define IPRT_INCLUDED_handle_h
38#ifndef RT_WITHOUT_PRAGMA_ONCE
39# pragma once
40#endif
41
42#include <iprt/cdefs.h>
43#include <iprt/types.h>
44
45RT_C_DECLS_BEGIN
46
47/** @defgroup grp_rt_handle RTHandle - Generic Handle Operations
48 * @ingroup grp_rt
49 * @{
50 */
51
52/**
53 * Closes or destroy a generic handle.
54 *
55 * @returns IPRT status code.
56 * @param ph Pointer to the generic handle. The structure handle
57 * will be set to NIL. A NULL pointer or a NIL handle
58 * will be quietly ignore (VINF_SUCCESS).
59 */
60RTDECL(int) RTHandleClose(PRTHANDLE ph);
61
62/**
63 * Gets one of the standard handles.
64 *
65 * @returns IPRT status code.
66 * @param enmStdHandle The standard handle.
67 * @param fLeaveOpen Whether closing the returned handle should leave the
68 * native standard handle open or not.
69 * Note! This currently only works with pipes and
70 * sockets!
71 * @param ph Pointer to the generic handle. This will contain
72 * the most appropriate IPRT handle on success.
73 */
74RTDECL(int) RTHandleGetStandard(RTHANDLESTD enmStdHandle, bool fLeaveOpen, PRTHANDLE ph);
75
76/** @} */
77
78RT_C_DECLS_END
79
80#endif /* !IPRT_INCLUDED_handle_h */
81
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