AwaymessageEnumerate

From TrillWiki

The awaymessageEnumerate function allows a plugin to request the names of all of the custom status settings a user has added.

Compatibility: 3.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks 5 Related Structures 5.1 awaymessage_entry_t

Syntax

plugin_send(MYGUID,"awaymessageEnumerate",awaymessage_enum_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

AwaymessageEnumerate utilitizes the awaymessage_enum_t structure.

struct awaymessage_enum_t
{
    unsigned int                struct_size;

    ttkCallback                 callback;
    void                        *data;
};

callback

The callback to receive the enumeration notifications for this. The enumerations will each be an awaymessage_entry_t structure.

data

The user data passed to the callback.

Return Value

This function returns 0 on success.

Remarks

None.

Related Structures

awaymessage_entry_t

struct awaymessage_entry_t
{
    unsigned int                struct_size;

    char                        *name;
};