Events actionStringRequest
From TrillWiki
The events_actionStringRequest notification is called when the events engine needs a string representation of the data associated with a particular custom event. The string should be in the form of XML attributes, ie: 'fruit="apple" color="red" state="rotten"'.
Compatibility: 2.0 and higher
Contents |
Syntax
callback(int window_id, char *icontrol, "events_actionStringRequest", void *data, void *userData);
Note that all Trillian functions and notifications begin with a lower-case letter, despite the Wiki requirement that all pages start with a capital letter.
Parameters
Events actionStringRequest utilitizes the NONE structure.
There is no structure used for this function or notification. For functions, the parameter passed to plugin_send should be a NULL. For notifications, the 'data' field may still contain a parameter, but it will not be a structure; if so, it will be detailed below.
The data passed with this message is the data associated with the particular event.
Return Value
Returns a char* string representing the data passed.
Remarks
Be sure to free the memory malloced in this call on events_actionStringDestroy.
The string must be a valid chunk of XML attributes; if you intend to include user-entered strings be sure they are escaped. Here's a string packed with errors:fruit=""Granny Smith" apple" color="purple < brown" state='rotten & bruised" description='Rachel's bad apple'
See also: events_actionStringDestroy
