add setExecutionParam and getExecutionParam for VBA parameter handling

simplified WriteToLog code

Author: rkapl123

Distribution/DBaddin32.xll

@@ -102,12 +102,30 @@ The DBModifiers can be executed either
 
 ... or be done on saving the Workbook.  
 
-... or by issuing the VBA command `result = Application.Run("executeDBModif", <DBModifierName>, <headlessFlag>)`, where `<DBModifierName>` is the Name of the DB Modifier including the type (so `DBMapperemployee` or `DBActionpublishersDelete`) and `<headlessFlag>` is a boolean flag indicating whether any user-interaction (as controllable by the Addin) should be avoided, all errors are returned in the `result` of the call.
+... or by issuing the VBA command `result = Application.Run("executeDBModif", <DBModifierName>, <headlessFlag>)`, where `<DBModifierName>` is the name of the DB Modifier including the type (so `DBMapperemployee` or `DBActionpublishersDelete`) and `<headlessFlag>` is a boolean flag indicating whether any user-interaction (as controllable by the Addin) should be avoided, all errors collected in `nonInteractiveErrMsgs` and returned in the `result` of the call.
 
 You can edit the DBModifiers either by Ctrl-Shift clicking the Execute DBModifier Groups dropdown menus..  
 .. or by Ctrl-Shift clicking the created command-buttons.  
 .. or by using the Insert/Edit DBFunc/DBModif context menu within a DBMapper or DBAction range.  
 
+## Additional macro functions available for setting/accessing settings
+
+By issuing the VBA command `Application.Run("setExecutionParam", Param, Value)`, where `Param` is the name of the parameter and `Value` is the value it should be set to, following settings can be set via VBA:
+*  headLess: sets nonInteractive to True or False
+*  selectedEnvironment: sets SettingsTools.selectedEnvironment to the value passed (zero based environment: 0 is the first, 1 the second, etc.)
+*  ConstConnString: sets SettingsTools.ConstConnString to the value passed
+*  CnnTimeout: sets SettingsTools.CnnTimeout to the value passed
+*  CmdTimeout: sets SettingsTools.CmdTimeout to the value passed
+
+By issuing the VBA command `result = Application.Run("getExecutionParam", Param)`, where `Param` is the name of the parameter the current settings of the following parameters are returned:
+*  selectedEnvironment: returns SettingsTools.selectedEnvironment (zero based environment: 0 is the first, 1 the second, etc.)
+*  env() : returns the selected environment (1 is the first, 2 the second, etc.)
+*  ConstConnString: returns SettingsTools.ConstConnString
+*  CnnTimeout: returns SettingsTools.CnnTimeout
+*  CmdTimeout: returns SettingsTools.CmdTimeout
+*  nonInteractiveErrMsgs: returns the currently collected error messages
+*  and any other key from the available DBAddin settings (in DBAddin.xll.config, DBAddinCentral.config or DBaddinUser.config)
+
 ## Additional settings ("hidden" as they are not available in creation dialogs)
 
 Following Settings of DBModifiers can only be edited in the Edit DBModifier Definitions Window:

Distribution/DBaddin64.xll

@@ -437,7 +437,7 @@ Public Class DBMapper : Inherits DBModif
             preventColResize = Convert.ToBoolean(getParamFromXML(definitionXML, "preventColResize", "Boolean"))
             deleteBeforeMapperInsert = Convert.ToBoolean(getParamFromXML(definitionXML, "deleteBeforeMapperInsert", "Boolean"))
             onlyRefreshTheseDBSheetLookups = getParamFromXML(definitionXML, "onlyRefreshTheseDBSheetLookups")
-            ' set table styles for DBMappers having a listobject underneath
+            ' set table styles for DBMappers having a list-object underneath
             Dim DBmapperListObj As Excel.ListObject = Nothing
             Try : DBmapperListObj = TargetRange.ListObject : Catch ex As Exception : End Try
             If DBmapperListObj IsNot Nothing Then
@@ -2243,6 +2243,55 @@ EndOuterLoop:
         End If
     End Function
 
+    ''' <summary>set given execution parameter, used for VBA call by Application.Run</summary>
+    ''' <param name="Param">execution parameter, like "selectedEnvironment" (zero based here!) or "CnnTimeout"</param>
+    ''' <param name="Value">execution parameter value</param>
+    <ExcelCommand(Name:="setExecutionParam")>
+    Public Sub setExecutionParam(Param As String, Value As Object)
+        Try
+            If Param = "headLess" Then
+                nonInteractive = Value
+                nonInteractiveErrMsgs = "" ' reset non-interactive messages
+            ElseIf Param = "selectedEnvironment" Then
+                SettingsTools.selectedEnvironment = Value
+                theRibbon.Invalidate()
+            ElseIf Param = "ConstConnString" Then
+                SettingsTools.ConstConnString = Value
+            ElseIf Param = "CnnTimeout" Then
+                SettingsTools.CnnTimeout = Value
+            ElseIf Param = "CmdTimeout" Then
+                SettingsTools.CmdTimeout = Value
+            Else
+                UserMsg("parameter " + Param + " not supported by setExecutionParams")
+                Exit Sub
+            End If
+        Catch ex As Exception
+            UserMsg("setting parameter " + Param + " with value " + CStr(Value) + " resulted in error " + ex.Message)
+        End Try
+    End Sub
+
+    ''' <summary>get given execution parameter or setting parameter found by fetchSetting, used for VBA call by Application.Run</summary>
+    ''' <param name="Param">execution parameter, like "selectedEnvironment" (zero based here!), "env()" or "CnnTimeout"</param>
+    ''' <returns>execution or setting parameter value</returns>
+    <ExcelCommand(Name:="getExecutionParam")>
+    Public Function getExecutionParam(Param As String) As Object
+        If Param = "selectedEnvironment" Then
+            Return SettingsTools.selectedEnvironment
+        ElseIf Param = "env()" Then
+            Return SettingsTools.env()
+        ElseIf Param = "ConstConnString" Then
+            Return SettingsTools.ConstConnString
+        ElseIf Param = "CnnTimeout" Then
+            Return SettingsTools.CnnTimeout
+        ElseIf Param = "CmdTimeout" Then
+            Return SettingsTools.CmdTimeout
+        ElseIf Param = "nonInteractiveErrMsgs" Then
+            Return nonInteractiveErrMsgs
+        Else
+            Return fetchSetting(Param, "parameter " + Param + " neither supported by getExecutionParam nor found with fetchSetting(Param)")
+        End If
+    End Function
+
     ''' <summary>marks a row in a DBMapper for deletion, used as a ExcelCommand to have a keyboard shortcut</summary>
     <ExcelCommand(Name:="deleteRow")>
     Public Sub deleteRow()

docs/DBModif.md

@@ -29,21 +29,13 @@ Public Module Logging
                 theLogDisplaySource.TraceEvent(TraceEventType.Information, timestamp, "Non-interactive: {0}: {1}", caller, Message)
                 theLogFileSource.TraceEvent(TraceEventType.Information, timestamp, "Non-interactive: {0}: {1}", caller, Message)
             Else
+                theLogDisplaySource.TraceEvent(eEventType, timestamp, "{0}: {1}", caller, Message)
+                theLogFileSource.TraceEvent(eEventType, timestamp, "{0}: {1}", caller, Message)
                 Select Case eEventType
-                    Case TraceEventType.Information
-                        theLogDisplaySource.TraceEvent(TraceEventType.Information, timestamp, "{0}: {1}", caller, Message)
-                        theLogFileSource.TraceEvent(TraceEventType.Information, timestamp, "{0}: {1}", caller, Message)
-                    Case TraceEventType.Warning
-                        theLogDisplaySource.TraceEvent(TraceEventType.Warning, timestamp, "{0}: {1}", caller, Message)
-                        theLogFileSource.TraceEvent(TraceEventType.Warning, timestamp, "{0}: {1}", caller, Message)
+                    Case TraceEventType.Warning, TraceEventType.Error
                         WarningIssued = True
                         ' at Addin Start ribbon has not been loaded so avoid call to it here..
                         If theRibbon IsNot Nothing Then theRibbon.InvalidateControl("showLog")
-                    Case TraceEventType.Error
-                        theLogDisplaySource.TraceEvent(TraceEventType.Error, timestamp, "{0}: {1}", caller, Message)
-                        theLogFileSource.TraceEvent(TraceEventType.Error, timestamp, "{0}: {1}", caller, Message)
-                        WarningIssued = True
-                        If theRibbon IsNot Nothing Then theRibbon.InvalidateControl("showLog")
                 End Select
             End If
         Catch ex As Exception

source/DBModif.vb

@@ -31,6 +31,6 @@ Imports System.Runtime.InteropServices
 ' You can specify all the values or you can default the Build and Revision Numbers 
 ' by using the '*' as shown below:
 
-<Assembly: AssemblyVersion("1.0.0.70")>
-<Assembly: AssemblyFileVersion("1.0.0.70")>
+<Assembly: AssemblyVersion("1.0.0.71")>
+<Assembly: AssemblyFileVersion("1.0.0.71")>
 <Assembly: NeutralResourcesLanguage("de-DE")>

source/Logging.vb

@@ -17,7 +17,7 @@ Public Module SettingsTools
     Public CmdTimeout As Integer
     ''' <summary>default formatting style used in DBDate</summary>
     Public DefaultDBDateFormatting As Integer
-    ''' <summary>The path where the User specific settings (overrides) can be found</summary>
+    ''' <summary>The path where the User specific settings (overrides of standard/global settings) can be found (hardcoded to path of xll)</summary>
     Private UserSettingsPath As String
 
     ''' <summary>exception proof fetching of integer settings</summary>