ds@1952: /**
ds@1952:  * vim: set ts=4 :
ds@1952:  * =============================================================================
ds@1952:  * SourceMod (C)2004-2008 AlliedModders LLC.  All rights reserved.
ds@1952:  * =============================================================================
ds@1952:  *
ds@1952:  * This file is part of the SourceMod/SourcePawn SDK.
ds@1952:  *
ds@1952:  * This program is free software; you can redistribute it and/or modify it under
ds@1952:  * the terms of the GNU General Public License, version 3.0, as published by the
ds@1952:  * Free Software Foundation.
ds@1952:  * 
ds@1952:  * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1952:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1952:  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1952:  * details.
ds@1952:  *
ds@1952:  * You should have received a copy of the GNU General Public License along with
ds@1952:  * this program.  If not, see <http://www.gnu.org/licenses/>.
ds@1952:  *
ds@1952:  * As a special exception, AlliedModders LLC gives you permission to link the
ds@1952:  * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1952:  * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1952:  * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1952:  * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1952:  * this exception to all derivative works.  AlliedModders LLC defines further
ds@1952:  * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1952:  * or <http://www.sourcemod.net/license.php>.
ds@1952:  *
ds@1952:  * Version: $Id$
ds@1952:  */
ds@1952: 
ds@1952: #if defined _handles_included
ds@1952:  #endinput
ds@1952: #endif
ds@1952: #define _handles_included
ds@1952: 
ds@1952: /**
ds@1952:  * Handle helper macros.
ds@1952:  */
ds@1952: enum Handle
ds@1952: {
ds@1952: 	INVALID_HANDLE = 0,
ds@1952: };
ds@1952: 
ds@1952: 
ds@1952: /**
ds@1952:  * Closes a Handle.  If the handle has multiple copies open, 
ds@1952:  * it is not destroyed unless all copies are closed.
ds@1952:  * 
ds@1952:  * @note Closing a Handle has a different meaning for each Handle type.  Make
ds@1952:  *       sure you read the documentation on whatever provided the Handle.
ds@1952:  *
ds@1952:  * @param hndl		Handle to close.
ds@1952:  * @return			True if successful, false if not closeable.
ds@1952:  * @error			Invalid handles will cause a run time error.
ds@1952:  */
ds@1952: native bool:CloseHandle(Handle:hndl);
ds@1952: 
ds@1952: /**
ds@1952:  * Clones a Handle.  When passing handles in between plugins, caching handles
ds@1952:  * can result in accidental invalidation when one plugin releases the Handle, or is its owner
ds@1952:  * is unloaded from memory.  To prevent this, the Handle may be "cloned" with a new owner.
ds@1952:  * 
ds@1952:  * @note Usually, you will be cloning Handles for other plugins.  This means that if you clone
ds@1952:  * the Handle without specifying the new owner, it will assume the identity of your original calling
ds@1952:  * plugin, which is not very useful.  You should either specify that the receiving plugin should
ds@1952:  * clone the handle on its own, or you should explicitly clone the Handle using the receiving plugin's
ds@1952:  * identity Handle.
ds@1952:  *
ds@1952:  * @param hndl		Handle to clone/duplicate.
ds@1952:  * @param plugin	Optional Handle to another plugin to mark as the new owner.
ds@1952:  *					If no owner is passed, the owner becomes the calling plugin.
ds@1952:  * @return			Handle on success, INVALID_HANDLE if not cloneable.
ds@1952:  * @error			Invalid handles will cause a run time error.
ds@1952:  */
ds@1952: native Handle:CloneHandle(Handle:hndl, Handle:plugin=INVALID_HANDLE);
ds@1952: 
ds@1952: /**
ds@1952:  * Do not use this function.  Returns if a Handle and its contents 
ds@1952:  * are readable, whereas INVALID_HANDLE only checks for the absence 
ds@1952:  * of a Handle.
ds@1952:  *
ds@1952:  * This function is intended only for tests where the validity of a 
ds@1952:  * Handle can absolutely not be known. 
ds@1952:  *
ds@1952:  * Do not use this to check the return values of functions, or to 
ds@1952:  * check if timers should be closed (except in very rare cases).  
ds@1952:  * This function is for very specific usage and using it for general 
ds@1952:  * purpose routines can and will hide very subtle bugs.
ds@1952:  *
ds@1952:  * @param hndl		Handle to test for validity.
ds@1952:  * @return			True if handle is valid, false otherwise.
ds@1952:  */
ds@1952: #pragma deprecated Do not use this function.
ds@1952: native bool:IsValidHandle(Handle:hndl);