Enum finish

From TrillWiki

Jump to: navigation, search

Given as the last message when an enumeration has completed. It will signify that no more enum_add's will be received and all memory can be cleaned up.

Compatibility: 1.0 and higher

Contents

Syntax

callback(0, NULL, "enum_finish", NULL, void *userData);

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

Enum finish utilitizes the NONE structure.

There is no structure used for this function or notification. For functions, the parameter passed to plugin_send should be a NULL. For notifications, the 'data' field may still contain a parameter, but it will not be a structure; if so, it will be detailed below.


Nothing is passed in.

Return Value

Must return 0.

Remarks

None.


See also: enum_start