From 5bf17fc5aeabd6295d25a228274a64d130d6547d Mon Sep 17 00:00:00 2001 From: David Anderson Date: Wed, 4 Nov 2009 13:52:12 -0500 Subject: [PATCH] Clarified handle invariants in clientprefs.inc (no bug, r=me). --- plugins/include/clientprefs.inc | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/plugins/include/clientprefs.inc b/plugins/include/clientprefs.inc index 50371764..a2bf272b 100644 --- a/plugins/include/clientprefs.inc +++ b/plugins/include/clientprefs.inc @@ -85,10 +85,14 @@ enum CookieMenuAction /** * 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 description Optional description of the preference 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. */ 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. * + * Handles returned by FindClientCookie can be closed via CloseHandle() when + * no longer needed. + * * @param name Name of cookie to find. * @return A handle to the cookie if it is found. INVALID_HANDLE otherwise. */