Updated C# API

Mostly just summary cleanup. Fixes LogF and replaces it to use C# string
formating instead of C++ style. Also adds some log overloads.

Author: tjhrulz

API/RainmeterAPI.cs

@@ -22,6 +22,11 @@ public API(IntPtr rm)
             m_Rm = rm;
         }
 
+        static public implicit operator API(IntPtr rm)
+        {
+            return new Rainmeter.API(rm);
+        }
+
         [DllImport("Rainmeter.dll", CharSet = CharSet.Unicode)]
         private extern static IntPtr RmReadString(IntPtr rm, string option, string defValue, bool replaceMeasures);
 
@@ -34,21 +39,35 @@ public API(IntPtr rm)
         [DllImport("Rainmeter.dll", CharSet = CharSet.Unicode)]
         private extern static IntPtr RmPathToAbsolute(IntPtr rm, string relativePath);
 
+        /// <summary>
+        /// Executes a command
+        /// </summary>
+        /// <param name="skin">Pointer to current skin (See API.GetSkin)</param>
+        /// <param name="command">Bang to execute</param>
+        /// <returns>No return type</returns>
+        /// <example>
+        /// <code>
+        /// [DllExport]
+        /// internal double Update(IntPtr data)
+        /// {
+        ///     Measure measure = (Measure)data;
+        ///     Rainmeter.API.Execute(measure->skin, "!SetVariable SomeVar 10");  // 'measure->skin' stored previously in the Initialize function
+        ///     return 0.0;
+        /// }
+        /// </code>
+        /// </example>
         [DllImport("Rainmeter.dll", EntryPoint = "RmExecute", CharSet = CharSet.Unicode)]
         public extern static void Execute(IntPtr skin, string command);
 
         [DllImport("Rainmeter.dll")]
         private extern static IntPtr RmGet(IntPtr rm, RmGetType type);
 
         [DllImport("Rainmeter.dll", CharSet = CharSet.Unicode, CallingConvention = CallingConvention.Cdecl)]
-        private extern static int LSLog(LogType type, string unused, string message);
+        private extern static int LSLog(int type, string unused, string message);
 
         [DllImport("Rainmeter.dll", CharSet = CharSet.Unicode, CallingConvention = CallingConvention.StdCall)]
         private extern static int RmLog(IntPtr rm, LogType type, string message);
 
-        [DllImport("Rainmeter.dll", CharSet = CharSet.Unicode, CallingConvention = CallingConvention.Cdecl)]
-        private extern static int RmLogF(IntPtr rm, LogType type, string format, params string[] message);
-
         private enum RmGetType
         {
             MeasureName = 0,
@@ -75,10 +94,13 @@ public enum LogType
         /// <returns>Returns the option value as a string</returns>
         /// <example>
         /// <code>
-        /// internal void Reload(Rainmeter.API rm, ref double maxValue)
+        /// [DllExport]
+        /// public static void Reload(IntPtr data, IntPtr rm, ref double maxValue)
         /// {
-        ///     string value = rm.ReadString("Value", "DefaultValue");
-        ///     string action = rm.ReadString("Action", "", false);  // [MeasureNames] will be parsed/replaced when the action is executed with RmExecute
+        ///     Measure measure = (Measure)data;
+        ///     Rainmeter.API api = (Rainmeter.API)rm;
+        ///     string value = api.ReadString("Value", "DefaultValue");
+        ///     string action = api.ReadString("Action", "", false);  // [MeasureNames] will be parsed/replaced when the action is executed with RmExecute
         /// }
         /// </code>
         /// </example>
@@ -95,9 +117,12 @@ public string ReadString(string option, string defValue, bool replaceMeasures =
         /// <returns>Returns the absolute path of the option value as a string</returns>
         /// <example>
         /// <code>
-        /// internal void Reload(Rainmeter.API rm, ref double maxValue)
+        /// [DllExport]
+        /// public static void Reload(IntPtr data, IntPtr rm, ref double maxValue)
         /// {
-        ///     string path = rm.ReadPath("MyPath", "C:\\");
+        ///     Measure measure = (Measure)data;
+        ///     Rainmeter.API api = (Rainmeter.API)rm;
+        ///     string path = api.ReadPath("MyPath", "C:\\");
         /// }
         /// </code>
         /// </example>
@@ -115,9 +140,12 @@ public string ReadPath(string option, string defValue)
         /// <returns>Returns the option value as a double</returns>
         /// <example>
         /// <code>
-        /// internal void Reload(Rainmeter.API rm, ref double maxValue)
+        /// [DllExport]
+        /// public static void Reload(IntPtr data, IntPtr rm, ref double maxValue)
         /// {
-        ///     double value = rm.ReadDouble("Value", 20.0);
+        ///     Measure measure = (Measure)data;
+        ///     Rainmeter.API api = (Rainmeter.API)rm;
+        ///     double value = api.ReadDouble("Value", 20.0);
         /// }
         /// </code>
         /// </example>
@@ -135,9 +163,12 @@ public double ReadDouble(string option, double defValue)
         /// <returns>Returns the option value as an integer</returns>
         /// <example>
         /// <code>
-        /// internal void Reload(Rainmeter.API rm, ref double maxValue)
+        /// [DllExport]
+        /// public static void Reload(IntPtr data, IntPtr rm, ref double maxValue)
         /// {
-        ///     int value = rm.ReadInt("Value", 20);
+        ///     Measure measure = (Measure)data;
+        ///     Rainmeter.API api = (Rainmeter.API)rm;
+        ///     int value = api.ReadInt("Value", 20);
         /// }
         /// </code>
         /// </example>
@@ -153,9 +184,11 @@ public int ReadInt(string option, int defValue)
         /// <returns>Returns a string replacing any variables in the 'str'</returns>
         /// <example>
         /// <code>
-        /// internal double Update()
+        /// [DllExport]
+        /// public static double Update(IntPtr data)
         /// {
-        ///     string myVar = ReplaceVariables("#MyVar#").ToUpperInvariant();
+        ///     Measure measure = (Measure)data;
+        ///     string myVar = measure.api.ReplaceVariables("#MyVar#").ToUpperInvariant(); // 'measure.api' stored previously in the Initialize function
         ///     if (myVar == "SOMETHING") { return 1.0; }
         ///     return 0.0;
         /// }
@@ -173,9 +206,13 @@ public string ReplaceVariables(string str)
         /// <returns>Returns the current measure name as a string</returns>
         /// <example>
         /// <code>
-        /// internal void Initialize(Rainmeter.API rm)
+        /// [DllExport]
+        /// public static void Initialize(ref IntPtr data, IntPtr rm)
         /// {
-        ///     myName = GetMeasureName();  // declare 'myName' as a string in class scope
+        ///     Measure measure = new Measure();
+        ///     Rainmeter.API api = (Rainmeter.API)rm;
+        ///     measure.myName = api.GetMeasureName();  // declare 'myName' as a string in measure class
+        ///     data = GCHandle.ToIntPtr(GCHandle.Alloc(measure));
         /// }
         /// </code>
         /// </example>
@@ -191,9 +228,13 @@ public string GetMeasureName()
         /// <returns>Returns an IntPtr to the current skin</returns>
         /// <example>
         /// <code>
-        /// internal void Initialize(Rainmeter.API rm)
+        /// [DllExport]
+        /// public static void Initialize(ref IntPtr data, IntPtr rm)
         /// {
-        ///     mySkin = GetSkin();  // declare 'mySkin' as a IntPtr in class scope
+        ///     Measure measure = new Measure();
+        ///     Rainmeter.API api = (Rainmeter.API)rm;
+        ///     measure.mySkin = api.GetSkin();  // declare 'mySkin' as a IntPtr in measure class
+        ///     data = GCHandle.ToIntPtr(GCHandle.Alloc(measure));
         /// }
         /// </code>
         /// </example>
@@ -203,21 +244,23 @@ public IntPtr GetSkin()
         }
 
         /// <summary>
-        /// Retrieves a path to the Rainmeter data file (Rainmeter.data).
+        /// Retrieves a path to the Rainmeter data file (Rainmeter.data)
         /// </summary>
         /// <remarks>Call GetSettingsFile() in the Initialize function and store the results for later use</remarks>
         /// <returns>Returns the path and filename of the Rainmeter data file as a string</returns>
         /// <example>
         /// <code>
-        /// internal void Initialize(Rainmeter.API rm)
+        /// public static void Initialize(ref IntPtr data, IntPtr rm)
         /// {
-        ///     if (rmDataFile == null) { rmDataFile = GetSettingsFile(); }  // declare 'rmDataFile' as a string in global scope
+        ///     data = GCHandle.ToIntPtr(GCHandle.Alloc(new Measure()));
+        ///     Rainmeter.API api = (Rainmeter.API)rm;
+        ///     if (rmDataFile == null) { rmDataFile = API.GetSettingsFile(); }  // declare 'rmDataFile' as a string in global scope
         /// }
         /// </code>
         /// </example>
-        public string GetSettingsFile()
+        public static string GetSettingsFile()
         {
-            return Marshal.PtrToStringUni(RmGet(m_Rm, RmGetType.SettingsFile));
+            return Marshal.PtrToStringUni(RmGet(IntPtr.Zero, RmGetType.SettingsFile));
         }
 
         /// <summary>
@@ -227,9 +270,13 @@ public string GetSettingsFile()
         /// <returns>Returns the path and filename of the skin as a string</returns>
         /// <example>
         /// <code>
-        /// internal void Initialize(Rainmeter.API rm)
+        /// [DllExport]
+        /// public static void Initialize(ref IntPtr data, IntPtr rm)
         /// {
-        ///     skinName = GetSkinName(); }  // declare 'skinName' as a string in class scope
+        ///     Measure measure = new Measure();
+        ///     Rainmeter.API api = (Rainmeter.API)rm;
+        ///     measure.skinName = api.GetSkinName(); }  // declare 'skinName' as a string in measure class
+        ///     data = GCHandle.ToIntPtr(GCHandle.Alloc(measure));
         /// }
         /// </code>
         /// </example>
@@ -238,16 +285,41 @@ public string GetSkinName()
             return Marshal.PtrToStringUni(RmGet(m_Rm, RmGetType.SkinName));
         }
 
+        /// <summary>
+        /// Executes a command auto getting the skin reference
+        /// </summary>
+        /// <param name="command">Bang to execute</param>
+        /// <returns>No return type</returns>
+        /// <example>
+        /// <code>
+        /// [DllExport]
+        /// public static double Update(IntPtr data)
+        /// {
+        ///     Measure measure = (Measure)data;
+        ///     measure.api.Execute("!SetVariable SomeVar 10");  // 'measure.api' stored previously in the Initialize function
+        ///     return 0.0;
+        /// }
+        /// </code>
+        /// </example>
+        public void Execute(string command)
+        {
+            Execute(this.GetSkin(), command);
+        }
+
         /// <summary>
         /// Returns a pointer to the handle of the skin window (HWND)
         /// </summary>
         /// <remarks>Call GetSkinWindow() in the Initialize function and store the results for later use</remarks>
         /// <returns>Returns a handle to the skin window as a IntPtr</returns>
         /// <example>
         /// <code>
+        /// [DllExport]
         /// internal void Initialize(Rainmeter.API rm)
         /// {
-        ///     skinWindow = GetSkinWindow(); }  // declare 'skinWindow' as a IntPtr in class scope
+        ///     Measure measure = new Measure();
+        ///     Rainmeter.API api = (Rainmeter.API)rm;
+        ///     measure.skinWindow = api.GetSkinWindow(); }  // declare 'skinWindow' as a IntPtr in measure class
+        ///     data = GCHandle.ToIntPtr(GCHandle.Alloc(measure));
         /// }
         /// </code>
         /// </example>
@@ -257,9 +329,9 @@ public IntPtr GetSkinWindow()
         }
 
         /// <summary>
-        /// DEPRECATED: Use Log(rm, type, message). Sends a message to the Rainmeter log.
+        /// DEPRECATED: Save your rm or api reference and use Log(rm, type, message). Sends a message to the Rainmeter log with no source.
         /// </summary>
-        public static void Log(LogType type, string message)
+        public static void Log(int type, string message)
         {
             LSLog(type, null, message);
         }
@@ -268,40 +340,98 @@ public static void Log(LogType type, string message)
         /// Sends a message to the Rainmeter log with source
         /// </summary>
         /// <remarks>LOG_DEBUG messages are logged only when Rainmeter is in debug mode</remarks>
-        /// <param name="type">Log type (LOG_ERROR, LOG_WARNING, LOG_NOTICE, or LOG_DEBUG)</param>
+        /// <param name="rm">Pointer to the plugin measure</param>
+        /// <param name="type">Log type, use API.LogType enum (Error, Warning, Notice, or Debug)</param>
         /// <param name="message">Message to be logged</param>
         /// <returns>No return type</returns>
         /// <example>
         /// <code>
-        /// Log(rm, LOG_NOTICE, "I am a 'notice' log message with a source");
+        /// Rainmeter.API.Log(rm, API.LogType.Notice, "I am a 'notice' log message with a source");
         /// </code>
         /// </example>
         public static void Log(IntPtr rm, LogType type, string message)
         {
             RmLog(rm, type, message);
         }
 
+        /// <summary>
         /// <summary>
         /// Sends a formatted message to the Rainmeter log
         /// </summary>
         /// <remarks>LOG_DEBUG messages are logged only when Rainmeter is in debug mode</remarks>
         /// <param name="rm">Pointer to the plugin measure</param>
-        /// <param name="level">Log level (LOG_ERROR, LOG_WARNING, LOG_NOTICE, or LOG_DEBUG)</param>
-        /// <param name="format">Formatted message to be logged, follows printf syntax</param>
+        /// <param name="type">Log type, use API.LogType enum (Error, Warning, Notice, or Debug)</param>
+        /// <param name="format">Formatted message to be logged, follows string.Format syntax</param>
         /// <param name="args">Comma separated list of args referenced in the formatted message</param>
         /// <returns>No return type</returns>
         /// <example>
         /// <code>
-        /// string notice = "notice";
-        /// LogF(rm, LOG_NOTICE, "I am a '%s' log message with a source", notice);
+        /// [DllExport]
+        /// public static double Update(IntPtr data)
+        /// {
+        ///     Measure measure = (Measure)data;
+        ///     string notice = "notice";
+        ///     measure.api.LogF(measure.rm, API.LogType.Notice, "I am a '{0}' log message with a source", notice); // 'measure.rm' stored previously in the Initialize function
+        ///     
+        ///     return 0.0;
+        /// }
         /// </code>
         /// </example>
-        public static void LogF(IntPtr rm, LogType type, string format, params string[] args)
+        public static void LogF(IntPtr rm, LogType type, string format, params Object[] args)
         {
-            RmLogF(rm, type, format, args);
+            RmLog(rm, type, string.Format(format, args));
+        }
+
+        /// <summary>
+        /// Sends a message to the Rainmeter log with source
+        /// </summary>
+        /// <remarks>LOG_DEBUG messages are logged only when Rainmeter is in debug mode</remarks>
+        /// <param name="type">Log type, use API.LogType enum (Error, Warning, Notice, or Debug)</param>
+        /// <param name="message">Message to be logged</param>
+        /// <returns>No return type</returns>
+        /// <example>
+        /// <code>
+        /// [DllExport]
+        /// public static double Update(IntPtr data)
+        /// {
+        ///     Measure measure = (Measure)data;
+        ///     measure.api.Log(api, API.LogType.Notice, "I am a 'notice' log message with a source"); // 'measure.api' stored previously in the Initialize function
+        ///     
+        ///     return 0.0;
+        /// }
+        /// </code>
+        /// </example>
+        public void Log(LogType type, string message)
+        {
+            RmLog(this.m_Rm, type, message);
         }
-    }
 
+        /// <summary>
+        /// Sends a formatted message to the Rainmeter log
+        /// </summary>
+        /// <remarks>LOG_DEBUG messages are logged only when Rainmeter is in debug mode</remarks>
+        /// <param name="type">Log type, use API.LogType enum (Error, Warning, Notice, or Debug)</param>
+        /// <param name="format">Formatted message to be logged, follows string.Format syntax</param>
+        /// <param name="args">Comma separated list of args referenced in the formatted message</param>
+        /// <returns>No return type</returns>
+        /// <example>
+        /// <code>
+        /// [DllExport]
+        /// public static double Update(IntPtr data)
+        /// {
+        ///     Measure measure = (Measure)data;
+        ///     string notice = "notice";
+        ///     measure.api.LogF(API.LogType.Notice, "I am a '{0}' log message with a source", notice); // 'measure.api' stored previously in the Initialize function
+        ///     
+        ///     return 0.0;
+        /// }
+        /// </code>
+        /// </example>
+        public void LogF(LogType type, string format, params Object[] args)
+        {
+            RmLog(this.m_Rm, type, string.Format(format, args));
+        }
+    }
     /// <summary>
     /// Dummy attribute to mark method as exported for DllExporter.exe.
     /// </summary>
@@ -310,6 +440,7 @@ public class DllExport : Attribute
     {
         public DllExport()
         {
+
         }
     }
 }