| 1 | /** @file
|
|---|
| 2 | * IPRT - Generic Handle Operations.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2010-2022 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_INCLUDED_handle_h
|
|---|
| 27 | #define IPRT_INCLUDED_handle_h
|
|---|
| 28 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 29 | # pragma once
|
|---|
| 30 | #endif
|
|---|
| 31 |
|
|---|
| 32 | #include <iprt/cdefs.h>
|
|---|
| 33 | #include <iprt/types.h>
|
|---|
| 34 |
|
|---|
| 35 | RT_C_DECLS_BEGIN
|
|---|
| 36 |
|
|---|
| 37 | /** @defgroup grp_rt_handle RTHandle - Generic Handle Operations
|
|---|
| 38 | * @ingroup grp_rt
|
|---|
| 39 | * @{
|
|---|
| 40 | */
|
|---|
| 41 |
|
|---|
| 42 | /**
|
|---|
| 43 | * Closes or destroy a generic handle.
|
|---|
| 44 | *
|
|---|
| 45 | * @returns IPRT status code.
|
|---|
| 46 | * @param ph Pointer to the generic handle. The structure handle
|
|---|
| 47 | * will be set to NIL. A NULL pointer or a NIL handle
|
|---|
| 48 | * will be quietly ignore (VINF_SUCCESS).
|
|---|
| 49 | */
|
|---|
| 50 | RTDECL(int) RTHandleClose(PRTHANDLE ph);
|
|---|
| 51 |
|
|---|
| 52 | /**
|
|---|
| 53 | * Gets one of the standard handles.
|
|---|
| 54 | *
|
|---|
| 55 | * @returns IPRT status code.
|
|---|
| 56 | * @param enmStdHandle The standard handle.
|
|---|
| 57 | * @param fLeaveOpen Whether closing the returned handle should leave the
|
|---|
| 58 | * native standard handle open or not.
|
|---|
| 59 | * Note! This currently only works with pipes and
|
|---|
| 60 | * sockets!
|
|---|
| 61 | * @param ph Pointer to the generic handle. This will contain
|
|---|
| 62 | * the most appropriate IPRT handle on success.
|
|---|
| 63 | */
|
|---|
| 64 | RTDECL(int) RTHandleGetStandard(RTHANDLESTD enmStdHandle, bool fLeaveOpen, PRTHANDLE ph);
|
|---|
| 65 |
|
|---|
| 66 | /** @} */
|
|---|
| 67 |
|
|---|
| 68 | RT_C_DECLS_END
|
|---|
| 69 |
|
|---|
| 70 | #endif /* !IPRT_INCLUDED_handle_h */
|
|---|
| 71 |
|
|---|
