MessageClose

From TrillWiki

The messageClose function allows a medium to close one of the windows it has opened.

Compatibility: 3.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

plugin_send(MYGUID,"messageClose",message_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

MessageClose utilitizes the message_t structure.

struct message_t
{
    unsigned int                struct_size;

    char                        *medium;
    int                         connection_id;

    char                        *name;
    char                        *type;
    char                        *text;

    char                        *location;

    void                        *extra_information;
    
    /* 2.0 
     */
    int                         window_id;
    unsigned int                extra_information_size;
    unsigned int                time_stamp;

    char                        *display_name;
    char                        *section;

    /* 3.0
     */
    struct capability_t         *capability_list;
    int                         text_len;
    int                         message_id;
};

window_id

The ID of the window to be closed.

medium

The medium of the window to be closed (if you don't give a window_id).

name

The name of the contact's window to be closed (if you don't give a window_id and it's a private conversation).

location

The name of the chat to be closed (if you don't give a window_id and it's a chat room).

connection_id

The id of the connection for the window to be closed (if you don't give a window_id).

Return Value

This function returns 0 on success, or a negative value if the window could not be found.

Remarks

None.