From c791f7f7209acc045ad7e89dcad54e01ff5cd705 Mon Sep 17 00:00:00 2001 From: David Anderson Date: Thu, 28 Aug 2008 17:20:17 +0000 Subject: [PATCH] Fixed doc for HandleSys failure outparams. --HG-- branch : sourcemod-1.0.x extra : convert_revision : svn%3A39bc706e-5318-0410-9160-8a85361fbb7c/branches/sourcemod-1.0.x%402480 --- public/IHandleSys.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/public/IHandleSys.h b/public/IHandleSys.h index b92cf828..7f60a831 100644 --- a/public/IHandleSys.h +++ b/public/IHandleSys.h @@ -246,7 +246,7 @@ namespace SourceMod * permissions. * @param ident Security token for any permissions. If typeAccess is NULL, this * becomes the owning identity. - * @param err Optional pointer to store an error code. + * @param err Optional pointer to store an error code on failure (undefined on success). * @return A new HandleType_t unique ID, or 0 on failure. */ virtual HandleType_t CreateType(const char *name, @@ -283,7 +283,7 @@ namespace SourceMod * @param object Object to bind to the handle. * @param owner Owner of the new Handle (may be NULL). * @param ident Identity for type access if needed (may be NULL). - * @param err Optional pointer to store an error code. + * @param err Optional pointer to store an error code on failure (undefined on success). * @return A new Handle_t, or 0 on failure. */ virtual Handle_t CreateHandle(HandleType_t type, @@ -349,7 +349,7 @@ namespace SourceMod * @param pSec Security pointer; pOwner is written as the owner, * pIdent is used as the parent identity for authorization. * @param pAccess Access right descriptor for the Handle; NULL for type defaults. - * @param err Optional pointer to store an error code. + * @param err Optional pointer to store an error code on failure (undefined on success). * @return A new Handle_t, or 0 on failure. */ virtual Handle_t CreateHandleEx(HandleType_t type,