diff --git a/dotnet/IEC61850forCSharp/IEC61850ServerAPI.cs b/dotnet/IEC61850forCSharp/IEC61850ServerAPI.cs
index be9251b4..90fd5bc8 100644
--- a/dotnet/IEC61850forCSharp/IEC61850ServerAPI.cs
+++ b/dotnet/IEC61850forCSharp/IEC61850ServerAPI.cs
@@ -2161,6 +2161,11 @@ namespace IEC61850
[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
static extern IntPtr SqliteLogStorage_createInstance(string filename);
+ ///
+ /// Create a new LogStorage instance using the embedded sqlite database
+ ///
+ /// name of the sqlite database file to be used
+ ///
public static LogStorage CreateLogStorage(string filename)
{
try
@@ -2219,26 +2224,59 @@ namespace IEC61850
this.self = self;
}
+ ///
+ /// Set the maximum number of log entries for this log
+ ///
+ /// the maximum number of log entries
private void SetMaxLogEntries(int maxEntries)
{
LogStorage_setMaxLogEntries(self, maxEntries);
}
+ ///
+ /// Get the maximum allowed number of log entries for this log
+ ///
+ /// the maximum number of log entries
private int GetMaxLogEntries()
{
return LogStorage_getMaxLogEntries(self);
}
+
+ ///
+ /// Manually add an entry to the log
+ ///
+ /// Usually this has not to be done by the user
+ /// but is done automatically by the library
+ /// the entry time of the new entry in ms
+ /// the entryID of the new log entry
public int AddEntry(long time)
{
return LogStorage_addEntry(self, time);
}
+ ///
+ /// Add new entry data to an existing log entry
+ ///
+ /// the ID of the log entry where the data will be added
+ /// the data reference of the log entry data
+ /// the data content as an unstructured binary data block
+ /// the size of the binary data block
+ /// the reasonCode of the LogEntryData
+ /// true if the entry data was successfully added, false otherwise
public bool AddEntryData(int entryID, string dataRef, byte[] data, int dataSize, int reasonCode)
{
-
return LogStorage_addEntryData(self, entryID, dataRef, data, dataSize, reasonCode);
}
+ ///
+ /// Get log entries specified by a time range
+ ///
+ /// start time of the time range
+ /// end time of the time range
+ ///
+ ///
+ ///
+ ///
public bool GetEntries(long startingTime, long endingTime, LogEntryCallback entryCallback, LogEntryDataCallback entryDataCallback, object parameter)
{
return LogStorage_getEntries(self, startingTime, endingTime, entryCallback, entryDataCallback, parameter);
diff --git a/src/logging/logging_api.h b/src/logging/logging_api.h
index 1cef5b01..0390c695 100644
--- a/src/logging/logging_api.h
+++ b/src/logging/logging_api.h
@@ -131,7 +131,7 @@ LogStorage_getMaxLogEntries(LogStorage self);
* \brief Add an entry to the log
*
* \param self the pointer of the LogStorage instance
- * \param timestamp the entry time of the new entry
+ * \param timestamp the entry time of the new entry (ms timestamp)
*
* \return the entryID of the new entry
*/