summaryrefslogtreecommitdiff
path: root/plugins/ExternalAPI/delphi/m_historystats.inc
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/ExternalAPI/delphi/m_historystats.inc')
-rw-r--r--plugins/ExternalAPI/delphi/m_historystats.inc41
1 files changed, 41 insertions, 0 deletions
diff --git a/plugins/ExternalAPI/delphi/m_historystats.inc b/plugins/ExternalAPI/delphi/m_historystats.inc
new file mode 100644
index 0000000000..03955de447
--- /dev/null
+++ b/plugins/ExternalAPI/delphi/m_historystats.inc
@@ -0,0 +1,41 @@
+{$IFNDEF M_HISTORYSTATS}
+{$DEFINE M_HISTORYSTATS}
+
+const
+(**
+ * The unique plugin interface ID provided by HistoryStats.
+ *
+ * @version 0.1.5.1+
+ *)
+ MIID_HISTORYSTATS:TGUD:= '$AF0DAD8E-$0695-$414B-$B306-$F4C7B7B41DA0';
+
+(**
+ * 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.
+ *)
+ 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.
+ *)
+ MS_HISTORYSTATS_SETEXCLUDE = 'HistoryStats/SetExclude';
+
+{$ENDIF}