InformationRequest

From TrillWiki

Jump to: navigation, search

The informationRequest notification is sent to a plugin when Trillian wants information for the plugin list, such as icon and description. Fill out the plugin_info_t as if you were answering the load notification.

Compatibility: 3.0 and higher

Contents

Syntax

plugin_main("informationRequest",plugin_info_t*);

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

InformationRequest utilitizes the plugin_info_t structure.

struct plugin_info_t
{
    unsigned int                struct_size;

    /* Information given to the plugin 
     */

    char                        *config_directory;
    char                        *skin_directory;
    char                        *temp_directory;

    plugin_function_send        plugin_send;

    /* Plugin Fills out this information 
     */

    char                        guid[128];

    char                        name[256];
    char                        company[256];
    char                        version[64];
    char                        description[1024];

    /* 2.0 information: given to the plugin
     */
    char                        *global_config_directory;
    char                        *trillian_directory;
    char                        *language_directory;

    /* 3.0 information: more information for plugin to fill out
     */
    unsigned char                *png_image_48;
    unsigned int                png_image_48_len;

    unsigned char                *png_image_32;
    unsigned int                png_image_32_len;
};


Return Value

1 if the plugin has provided plugin information using the "pluginInformationUpdate" command, 0 otherwise.

Remarks

This may be sent to plugins which have not otherwise been loaded/initialized, and which are technically not active. Refer to the load notification page for more information.


Personal tools