initterm.h revision 49d36b55bcf206ced156a303dab448a75fac001b
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * InnoTek Portable Runtime - Runtime Init/Term.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * Copyright (C) 2006 InnoTek Systemberatung GmbH
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * available from http://www.virtualbox.org. This file is free software;
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * you can redistribute it and/or modify it under the terms of the GNU
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * General Public License as published by the Free Software Foundation,
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * distribution. VirtualBox OSE is distributed in the hope that it will
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * be useful, but WITHOUT ANY WARRANTY of any kind.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * If you received this file as part of a commercial VirtualBox
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * distribution, then only the terms of your commercial VirtualBox
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * license agreement apply instead of the previous paragraph.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync/** @defgroup grp_rt InnoTek Portable Runtime APIs
49d36b55bcf206ced156a303dab448a75fac001bvboxsync/** @defgroup grp_rt_initterm Init / Term
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * Initalizes the runtime library.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * @returns iprt status code.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * @param fInitSUPLib Set if SUPInit() shall be called during init (default).
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * Clear if not to call it.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * @param cbReserve The number of bytes of contiguous memory that should be reserved by
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * the runtime / support library.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * Set this to 0 if no reservation is required. (default)
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * Set this to ~(size_t)0 if the maximum amount supported by the VM is to be
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * attempted reserved, or the maximum available.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * This argument only applies if fInitSUPLib is true and we're in ring-3 HC.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * Terminates the runtime library.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * Initalizes the ring-0 driver runtime library.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * @returns iprt status code.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * @param fReserved Flags reserved for the future.
49d36b55bcf206ced156a303dab448a75fac001bvboxsync * Terminates the ring-0 driver runtime library.