Mercurial > pidgin
diff src/request.h @ 11201:07dc8c6a359f
[gaim-migrate @ 13329]
This hopefully fixes a lot of potential crashes in the SILC PRPL.
Possible things to do:
-Backport these changes to oldstatus
-Ask the SILC guy to make sure all of these make sense. It's
likely there are better things that could be used as handles
-Check for other places in Gaim that don't give handles when
they should
committer: Tailor Script <tailor@pidgin.im>
| author | Mark Doliner <mark@kingant.net> |
|---|---|
| date | Mon, 08 Aug 2005 02:18:16 +0000 |
| parents | 2ab4b5acc8d1 |
| children | f0bc5f121684 |
line wrap: on
line diff
--- a/src/request.h Mon Aug 08 01:40:41 2005 +0000 +++ b/src/request.h Mon Aug 08 02:18:16 2005 +0000 @@ -1068,7 +1068,19 @@ /** * Prompts the user for text input. * - * @param handle The plugin or connection handle. + * @param handle The plugin or connection handle. For some + * things this is EXTREMELY important. The + * handle is used to programmatically close + * the request dialog when it is no longer + * needed. For PRPLs this is often a pointer + * to the GaimConnection instance. For plugins + * this should be a similar, unique memory + * location. This value is important because + * it allows a request to be closed, say, when + * you sign offline. If the request is NOT + * closed it is VERY likely to cause a crash + * whenever the callback handler functions are + * triggered. * @param title The title of the message. * @param primary The main point of the message. * @param secondary The secondary information. @@ -1097,7 +1109,9 @@ /** * Prompts the user for multiple-choice input. * - * @param handle The plugin or connection handle. + * @param handle The plugin or connection handle. For some + * things this is EXTREMELY important. See + * the comments on gaim_request_input. * @param title The title of the message. * @param primary The main point of the message. * @param secondary The secondary information. @@ -1122,7 +1136,9 @@ /** * Prompts the user for multiple-choice input. * - * @param handle The plugin or connection handle. + * @param handle The plugin or connection handle. For some + * things this is EXTREMELY important. See + * the comments on gaim_request_input. * @param title The title of the message. * @param primary The main point of the message. * @param secondary The secondary information. @@ -1149,7 +1165,9 @@ * * This is often represented as a dialog with a button for each action. * - * @param handle The plugin or connection handle. + * @param handle The plugin or connection handle. For some + * things this is EXTREMELY important. See + * the comments on gaim_request_input. * @param title The title of the message. * @param primary The main point of the message. * @param secondary The secondary information. @@ -1170,7 +1188,9 @@ * * This is often represented as a dialog with a button for each action. * - * @param handle The plugin or connection handle. + * @param handle The plugin or connection handle. For some + * things this is EXTREMELY important. See + * the comments on gaim_request_input. * @param title The title of the message. * @param primary The main point of the message. * @param secondary The secondary information. @@ -1190,7 +1210,9 @@ /** * Displays groups of fields for the user to fill in. * - * @param handle The plugin or connection handle. + * @param handle The plugin or connection handle. For some + * things this is EXTREMELY important. See + * the comments on gaim_request_input. * @param title The title of the message. * @param primary The main point of the message. * @param secondary The secondary information. @@ -1257,7 +1279,9 @@ * Displays a file selector request dialog. Returns the selected filename into * the callback. Can be used for either opening a file or saving a file. * - * @param handle The plugin or connection handle. + * @param handle The plugin or connection handle. For some + * things this is EXTREMELY important. See + * the comments on gaim_request_input. * @param title The title for the dialog (may be NULL) * @param filename The default filename (may be NULL) * @param savedialog True if this dialog is being used to save a file.