doc: add hashtable sent to callback for irc redirection in plugin API reference

v2.8-utf8proc
Sebastien Helleu 2012-01-05 10:52:26 +01:00
parent 7e7fe2b37d
commit b7c97d64ee
3 changed files with 36 additions and 0 deletions

View File

@ -7688,6 +7688,17 @@ When complete answer to your command has been be received, a hsignal will be
send. This hsignal has name 'irc_redirection_xxx_yyy' where 'xxx' is the
'signal' and 'yyy' the 'pattern' used.
Hashtable sent in hsignal has following content (key and values are strings):
* 'output': output of command (messages are separated by "\n")
* 'output_size': number of bytes in 'output' (as string)
* 'error': error string (if an error occurred):
** 'timeout': redirection stopped after timeout
* 'server': internal server name
* 'pattern': redirect pattern
* 'signal': signal name
* 'command': redirected command
C example:
[source,C]

View File

@ -7802,6 +7802,18 @@ Lorsque la réponse complète à votre commande a été reçue, un hsignal est e
Ce hsignal a le nom 'irc_redirection_xxx_yyy' où 'xxx' est le 'signal' et 'yyy'
le 'pattern' utilisé.
La hashtable envoyée dans le hsignal a le contenu suivant (les clés et valeurs
sont des chaînes) :
* 'output' : sortie de la commande (les messages sont séparés par "\n")
* 'output_size' : nombre d'octets dans 'output' (sous forme de chaîne)
* 'error' : chaîne d'erreur (si une erreur s'est produite) :
** 'timeout' : redirection stoppée après le délai maximum dépassé
* 'server' : nom interne du serveur
* 'pattern' : modèle de redirection
* 'signal' : nom du signal
* 'command' : commande redirigée
Exemple en C :
[source,C]

View File

@ -7735,6 +7735,19 @@ Quando è stata ricevuta la risposta completa dal proprio comando, verrà
inviato un hsignal. Questo hsignal ha il nome 'irc_redirection_xxx_yyy' dove
'xxx' è il segnale e 'yyy' lo 'schema' usato.
// TRANSLATION MISSING
Hashtable sent in hsignal has following content (key and values are strings):
// TRANSLATION MISSING
* 'output': output of command (messages are separated by "\n")
* 'output_size': number of bytes in 'output' (as string)
* 'error': error string (if an error occurred):
** 'timeout': redirection stopped after timeout
* 'server': internal server name
* 'pattern': redirect pattern
* 'signal': signal name
* 'command': redirected command
Esempio in C:
[source,C]