/** @file
 * IPRT - Generic Handle Operations.
 */

/*
 * Copyright (C) 2010-2022 Oracle and/or its affiliates.
 *
 * This file is part of VirtualBox base platform packages, as
 * available from https://www.virtualbox.org.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation, in version 3 of the
 * License.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <https://www.gnu.org/licenses>.
 *
 * The contents of this file may alternatively be used under the terms
 * of the Common Development and Distribution License Version 1.0
 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
 * in the VirtualBox 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.
 *
 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
 */

#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   fLeaveOpen      Whether closing the returned handle should leave the
 *                          native standard handle open or not.
 *                          Note! This currently only works with pipes and
 *                                sockets!
 * @param   ph              Pointer to the generic handle.  This will contain
 *                          the most appropriate IPRT handle on success.
 */
RTDECL(int) RTHandleGetStandard(RTHANDLESTD enmStdHandle, bool fLeaveOpen, PRTHANDLE ph);

/** @} */

RT_C_DECLS_END

#endif /* !IPRT_INCLUDED_handle_h */