initterm.h revision 49d36b55bcf206ced156a303dab448a75fac001b
/** @file
*/
/*
* Copyright (C) 2006 InnoTek Systemberatung GmbH
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License 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.
*
* If you received this file as part of a commercial VirtualBox
* distribution, then only the terms of your commercial VirtualBox
* license agreement apply instead of the previous paragraph.
*/
#ifndef __iprt_initterm_h__
#define __iprt_initterm_h__
/** @defgroup grp_rt InnoTek Portable Runtime APIs
* @{
*/
/** @defgroup grp_rt_initterm Init / Term
* @{
*/
#ifdef IN_RING3
/**
* Initalizes the runtime library.
*
* @returns iprt status code.
*
* @param fInitSUPLib Set if SUPInit() shall be called during init (default).
* Clear if not to call it.
* @param cbReserve The number of bytes of contiguous memory that should be reserved by
* the runtime / support library.
* Set this to 0 if no reservation is required. (default)
* Set this to ~(size_t)0 if the maximum amount supported by the VM is to be
* attempted reserved, or the maximum available.
* This argument only applies if fInitSUPLib is true and we're in ring-3 HC.
*/
#ifdef __cplusplus
bool fInitSUPLib = true,
#else
bool fInitSUPLib,
#endif
);
/**
* Terminates the runtime library.
*/
#endif
#ifdef IN_RING0
/**
* Initalizes the ring-0 driver runtime library.
*
* @returns iprt status code.
* @param fReserved Flags reserved for the future.
*/
/**
* Terminates the ring-0 driver runtime library.
*/
#endif
/** @} */
/** @} */
#endif