summaryrefslogtreecommitdiff
path: root/plugins/ExternalAPI/m_historystats.h
blob: f0ceaceb1d3ac71a519fbd458c9b4339d7b191c2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
#ifndef _M_HISTORYSTATS_H
#define _M_HISTORYSTATS_H

/**
 * The unique plugin interface ID provided by HistoryStats.
 *
 * @version 0.1.5.1+
 */
#define MIID_HISTORYSTATS { 0xaf0dad8e, 0xe695, 0x414b, { 0xb3, 0x06, 0xf4, 0xc7, 0xb7, 0xb4, 0x1d, 0xa0 } }

/**
 * Checks if a specified contact is set to be excluded from the statistics generated
 * by HistoryStats. If you check this for a MetaContact or for subcontacts of a
 * MetaContact you might want to check the subcontacts and the MetaContact itself, too.
 *
 * @version 0.1.5.1+
 * @param   wParam (WPARAM)(HANDLE) of the contact you'd like to query. NULL is not a
 *                 valid value for this parameter.
 * @param   lParam Must be set to 0.
 * @return  Returns 1 if the specified contact is set to be excluded and 0 otherwise.
 */
#define MS_HISTORYSTATS_ISEXCLUDED "HistoryStats/IsExcluded"

/**
 * Sets if a specified contact should be included in or excluded from the statistics
 * generated by HistoryStats. Setting this on a MetaContact or on a subcontact of a
 * MetaContact might have no effect, depending on the users configuration. Setting
 * this for a MetaContact and all its subcontacts at once should always produce the
 * expected result.
 *
 * @version 0.1.5.1+
 * @param   wParam (WPARAM)(HANDLE) of the contact you'd like to manipulate. NULL is
 *                 not a valid value for this parameter.
 * @param   lParam (LPARAM)(int) of 1 if you want to exclude the specified contact or
 *                 0 if you no longer want to exclude the specified contact.
 * @return  Always returns 0.
 */
#define MS_HISTORYSTATS_SETEXCLUDE "HistoryStats/SetExclude"

#endif // _M_HISTORYSTATS_H