UNLOZE/sourcemod
10
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Clarified handle invariants in clientprefs.inc (no bug, r=me).

Browse Source
This commit is contained in:
David Anderson 2009-11-04 13:52:12 -05:00
parent 33ca5943fa
commit 5bf17fc5ae
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
plugins/include/clientprefs.inc
View File

@ -85,10 +85,14 @@ enum CookieMenuAction
/** /**
* Creates a new Client preference cookie. * Creates a new Client preference cookie.
* *
* Handles returned by RegClientCookie can be closed via CloseHandle() when
* no longer needed.
*
* @param name Name of the new preference cookie. * @param name Name of the new preference cookie.
* @param description Optional description of the preference cookie. * @param description Optional description of the preference cookie.
* @param access What CookieAccess level to assign to this cookie. * @param access What CookieAccess level to assign to this cookie.
* @return A handle to the newly created cookie. If the cookie already exists, a handle to it will still be returned. * @return A handle to the newly created cookie. If the cookie already
* exists, a handle to it will still be returned.
* @error Cookie name is blank. * @error Cookie name is blank.
*/ */
native Handle:RegClientCookie(const String:name[], const String:description[], CookieAccess:access); native Handle:RegClientCookie(const String:name[], const String:description[], CookieAccess:access);
@ -96,6 +100,9 @@ native Handle:RegClientCookie(const String:name[], const String:description[], C
/** /**
* Searches for a Client preference cookie. * Searches for a Client preference cookie.
* *
* Handles returned by FindClientCookie can be closed via CloseHandle() when
* no longer needed.
*
* @param name Name of cookie to find. * @param name Name of cookie to find.
* @return A handle to the cookie if it is found. INVALID_HANDLE otherwise. * @return A handle to the cookie if it is found. INVALID_HANDLE otherwise.
*/ */