ContactlistSectionEnumerate

From TrillWiki

The contactlistSectionEnumerate function will enumerate through all the Contact Lists currently within the contact list. This will only enumerate the contact sections, and not all the sections within the contact list (such as My Mail, etc).

Compatibility: 2.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

plugin_send(MYGUID, "contactlistSectionEnumerate", struct contactlist_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

ContactlistSectionEnumerate utilitizes the contactlist_enum_t structure.

struct contactlist_enum_t
{
    unsigned int                struct_size;

    char                        *medium;

    int                         connection_id;

    ttkCallback                 callback;
    
    void                        *data;

    /* 2.0
     */
    char                        *section;
};

Return Value

Negative value on error, 0 on success.

Remarks

The default section will be NULL. All other sections will be returned as text in the contactlist_entry_t struct passed to enum_add.

See also: contactlistEnumerate