EventsStatusUpdate

From TrillWiki

The eventsStatusUpdate function will update an existing status that has been registered with eventsStatusRegister. This is normally used to update the description of a status when a language change occurs.

Compatibility: 2.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

plugin_send(MYGUID, "eventsStatusUpdate", struct event_status_register_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

EventsStatusUpdate utilitizes the event_status_register_t structure.

struct event_status_register_t
{
    unsigned int                struct_size;

    char                        *medium;
    char                        *status;
    char                        *description;

    int                         default_status;
    int                         event_id;

    ttkCallback                 callback;
    void                        *data;

    /* 3.0
     */

    unsigned char               *png_image;
    unsigned int                png_image_len;
};

medium

The medium for the particular status.

status

The status string. This must not change from load to load, ie: do not change this with language changes

description

A string representing the above status. This may change with language changes and will be used when the above status is shown to the user.

event_id

The event id returned from the eventsStatusRegister call. You may use this or use the medium/status combination.

Return Value

Negative value on error, 0 on success.

Remarks

None.