PrefsValueUnregister

From TrillWiki

The prefsValueUnregister function is used to tell Trillian you are no longer interested in a parameter.

Compatibility: 3.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

plugin_send(MYGUID, "prefsValueUnregister", plugin_prefs_value_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

PrefsValueUnregister utilitizes the plugin_prefs_value_register_t structure.

struct plugin_prefs_value_register_t
{
    unsigned int                struct_size;

    char                        *value;

    ttkCallback                 callback;
    void                        *data;

    /*
     */
    int                         watcher;
};

value

The name of the preference setting. See NotePreferenceNames for a list.

watcher

0 or 1, must be the same that you used when you registered.

callback

The callback.

Return Value

This function returns 0 on success, or a negative value if an error occurred.

Remarks

None.