handle.h revision 628393acb2b68337836dd6c2a69ff3b331fc84db
/** @file
* IPRT - Generic Handle Operations.
*/
/*
* Copyright (C) 2010 Sun Microsystems, Inc.
*
* 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.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 USA or visit http://www.sun.com if you need
* additional information or have any questions.
*/
#ifndef ___iprt_handle_h
#define ___iprt_handle_h
#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);
/** @} */
RT_C_DECLS_END
#endif