summaryrefslogtreecommitdiff
path: root/plugins/ExternalAPI/m_historystats.h
diff options
context:
space:
mode:
authorGeorge Hazan <george.hazan@gmail.com>2014-03-04 23:23:45 +0000
committerGeorge Hazan <george.hazan@gmail.com>2014-03-04 23:23:45 +0000
commit15855fa84a09fd1fd486d357c38db0f2bd181e74 (patch)
treec98d1ae74abca41c776522059343eda13a7e0a31 /plugins/ExternalAPI/m_historystats.h
parent819f8efabea6b0d7d971f9e6e4b21bbc18838874 (diff)
HistoryStats compiles ok now
git-svn-id: http://svn.miranda-ng.org/main/trunk@8399 1316c22d-e87f-b044-9b9b-93d7a3e3ba9c
Diffstat (limited to 'plugins/ExternalAPI/m_historystats.h')
-rw-r--r--plugins/ExternalAPI/m_historystats.h40
1 files changed, 40 insertions, 0 deletions
diff --git a/plugins/ExternalAPI/m_historystats.h b/plugins/ExternalAPI/m_historystats.h
new file mode 100644
index 0000000000..d36411d7ed
--- /dev/null
+++ b/plugins/ExternalAPI/m_historystats.h
@@ -0,0 +1,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