- C#/.NET API: fixed problem with boolean marshalling together with VC++ compiled DLL

dotnet/IEC61850forCSharp/Control.cs

@@ -100,8 +100,6 @@ namespace IEC61850
         /// </summary>
 		public class ControlObject
 		{
-
-
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
 			private static extern LastApplErrorInternal ControlObjectClient_getLastApplError(IntPtr self);
 
@@ -115,15 +113,19 @@ namespace IEC61850
 			private static extern int ControlObjectClient_getControlModel(IntPtr self);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
 			private static extern bool ControlObjectClient_operate(IntPtr self, IntPtr ctlVal, UInt64 operTime);
 
             [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
             private static extern bool ControlObjectClient_select(IntPtr self);
 
             [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
             private static extern bool ControlObjectClient_selectWithValue(IntPtr self, IntPtr ctlVal);
 
             [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
             private static extern bool ControlObjectClient_cancel(IntPtr self);
 
             [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]

dotnet/IEC61850forCSharp/IEC61850ClientAPI.cs

@@ -55,6 +55,7 @@ namespace IEC61850
 			static extern float MmsValue_toFloat (IntPtr self);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
 			static extern bool MmsValue_getBoolean (IntPtr self);
 
 			[DllImport ("iec61850", CallingConvention=CallingConvention.Cdecl)]
@@ -136,7 +137,7 @@ namespace IEC61850
 			static extern void IedConnection_deleteDataSet (IntPtr self, out int error, string dataSetReference);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
-			static extern IntPtr IedConnection_getDataSetDirectory (IntPtr self, out int error, string dataSetReference, out bool isDeletable);
+            static extern IntPtr IedConnection_getDataSetDirectory(IntPtr self, out int error, string dataSetReference, [MarshalAs(UnmanagedType.I1)] out bool isDeletable);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
 			static extern IntPtr IedConnection_getMmsConnection (IntPtr self);
@@ -894,11 +895,31 @@ namespace IEC61850
 					throw new IedConnectionException ("Failed to delete data set", error);
 			}
 
+            /// <summary>
+            /// Get the directory of the data set.
+            /// </summary>
+            /// <description>This function returns a list of object references with appended functional constraints (FC) of the data set elemenents.</description>
+            /// <param name="dataSetReference">The object reference of the data set</param>
+            /// <returns>the list of object references</returns>
+            /// <exception cref="IedConnectionException">This exception is thrown if there is a connection or service error</exception>
+            public List<string> GetDataSetDirectory(string dataSetReference)
+            {
+                bool isDeletable;
+
+                return GetDataSetDirectory(dataSetReference, out isDeletable);
+            }
+
+            /// <summary>
+            /// Get the directory of the data set.
+            /// </summary>
+            /// <description>This function returns a list of object references with appended functional constraints (FC) of the data set elemenents.</description>
+            /// <param name="dataSetReference">The object reference of the data set</param>
+            /// <param name="isDeletable">Indication if this data set is permanent or deletable.</param>
+            /// <returns>the list of object references</returns>
 			/// <exception cref="IedConnectionException">This exception is thrown if there is a connection or service error</exception>
-			public List<string> GetDataSetDirectory (string dataSetReference)
+			public List<string> GetDataSetDirectory (string dataSetReference, out bool isDeletable)
 			{
 				int error;
-				bool isDeletable;
 
 				IntPtr linkedList = IedConnection_getDataSetDirectory (connection, out error, dataSetReference, out isDeletable);
 

dotnet/IEC61850forCSharp/IEC61850forCSharp.csproj

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project DefaultTargets="Build" ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
     <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>

dotnet/IEC61850forCSharp/MmsValue.cs

@@ -47,6 +47,7 @@ namespace IEC61850
 			static extern double MmsValue_toDouble (IntPtr self);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
 			static extern bool MmsValue_getBoolean (IntPtr self);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
@@ -62,6 +63,7 @@ namespace IEC61850
 			static extern void MmsValue_setBitStringBit(IntPtr self, int bitPos, bool value);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
 			static extern bool MmsValue_getBitStringBit(IntPtr self, int bitPos);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
@@ -131,6 +133,7 @@ namespace IEC61850
 			static extern IntPtr MmsValue_getOctetStringBuffer(IntPtr self);
 
             [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
             static extern bool MmsValue_equals(IntPtr self, IntPtr otherValue);
 
 

dotnet/IEC61850forCSharp/ReportControlBlock.cs

@@ -56,6 +56,7 @@ namespace IEC61850
 			static extern void IedConnection_setRCBValues (IntPtr connection, out int error, IntPtr rcb, UInt32 parametersMask, bool singleRequest);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
 			static extern bool ClientReportControlBlock_isBuffered (IntPtr self);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
@@ -65,12 +66,14 @@ namespace IEC61850
 			static extern void ClientReportControlBlock_setRptId (IntPtr self, string rptId);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
 			static extern bool ClientReportControlBlock_getRptEna (IntPtr self);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
-			static extern void ClientReportControlBlock_setRptEna (IntPtr self, bool rptEna);
+            static extern void ClientReportControlBlock_setRptEna(IntPtr self, bool rptEna);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
 			static extern bool ClientReportControlBlock_getResv (IntPtr self);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
@@ -113,12 +116,14 @@ namespace IEC61850
 			static extern void ClientReportControlBlock_setIntgPd (IntPtr self, UInt32 intgPd);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
 			static extern bool ClientReportControlBlock_getGI (IntPtr self);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
 			static extern void ClientReportControlBlock_setGI (IntPtr self, bool gi);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
 			static extern bool ClientReportControlBlock_getPurgeBuf (IntPtr self);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]

dotnet/IEC61850forCSharp/Reporting.cs

@@ -68,6 +68,7 @@ namespace IEC61850
 		{
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
 			static extern bool ClientReport_hasTimestamp (IntPtr self);
 
 			[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
@@ -80,27 +81,33 @@ namespace IEC61850
 			static extern int ClientReport_getReasonForInclusion(IntPtr self, int elementIndex);
 
             [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
             static extern bool ClientReport_hasSeqNum(IntPtr self);
 
             [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
             static extern UInt16 ClientReport_getSeqNum(IntPtr self);
 
             [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
             static extern bool ClientReport_hasDataSetName(IntPtr self);
 
             [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
             static extern bool ClientReport_hasReasonForInclusion(IntPtr self);
 
             [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
             static extern bool ClientReport_hasConfRev(IntPtr self);
 
             [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
             static extern UInt32 ClientReport_getConfRev(IntPtr self);
 
             [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
             static extern bool ClientReport_hasBufOvfl(IntPtr self);
 
             [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
+            [return: MarshalAs(UnmanagedType.I1)]
             static extern bool ClientReport_hasDataReference(IntPtr self);
 
             [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]

src/iec61850/client/ied_connection.c

@@ -34,6 +34,7 @@
 #include "mms_value_internal.h"
 
 #define DEFAULT_CONNECTION_TIMEOUT 10000
+#define DATA_SET_MAX_NAME_LENGTH 64 /* is 32 according to standard! */
 
 typedef struct sICLogicalDevice
 {
@@ -1827,7 +1828,7 @@ IedConnection_createDataSet(IedConnection self, IedClientError* error, const cha
 {
 
     char domainIdBuffer[65];
-    char itemIdBuffer[33]; /* maximum data set name = 32 chars */
+    char itemIdBuffer[DATA_SET_MAX_NAME_LENGTH + 1];
 
     const char* domainId;
     const char* itemId;
@@ -1899,7 +1900,7 @@ void
 IedConnection_deleteDataSet(IedConnection self, IedClientError* error, const char* dataSetReference)
 {
     char domainId[65];
-    char itemId[33];
+    char itemId[DATA_SET_MAX_NAME_LENGTH + 1];
     bool isAssociationSpecific = false;
 
     int dataSetReferenceLength = strlen(dataSetReference);
@@ -1912,7 +1913,7 @@ IedConnection_deleteDataSet(IedConnection self, IedClientError* error, const cha
 
         const char* itemIdString = dataSetReference + strlen(domainId) + 1;
 
-        if (strlen(itemIdString) > 32) {
+        if (strlen(itemIdString) > DATA_SET_MAX_NAME_LENGTH) {
             *error = IED_ERROR_OBJECT_REFERENCE_INVALID;
             goto exit_function;
         }
@@ -1953,7 +1954,7 @@ IedConnection_getDataSetDirectory(IedConnection self, IedClientError* error, con
     LinkedList dataSetMembers = NULL;
 
     char domainIdBuffer[65];
-    char itemIdBuffer[129];
+    char itemIdBuffer[DATA_SET_MAX_NAME_LENGTH + 1];
 
     const char* domainId = NULL;
     const char* itemId = NULL;
@@ -1962,9 +1963,22 @@ IedConnection_getDataSetDirectory(IedConnection self, IedClientError* error, con
 
     if (dataSetReference[0] != '@') {
         domainId = MmsMapping_getMmsDomainFromObjectReference(dataSetReference, domainIdBuffer);
-        char* itemIdRef = copyStringToBuffer(dataSetReference + strlen(domainId) + 1, itemIdBuffer);
+
-        StringUtils_replace(itemIdRef, '.', '$');
+        if (domainId == NULL) {
-        itemId = itemIdRef;
+            *error = IED_ERROR_OBJECT_REFERENCE_INVALID;
+            goto exit_function;
+        }
+
+        const char* itemIdRef = dataSetReference + strlen(domainId) + 1;
+
+        if (strlen(itemIdRef) > DATA_SET_MAX_NAME_LENGTH) {
+            *error = IED_ERROR_OBJECT_REFERENCE_INVALID;
+            goto exit_function;
+        }
+
+        char* itemIdRefInBuffer = copyStringToBuffer(itemIdRef, itemIdBuffer);
+        StringUtils_replace(itemIdRefInBuffer, '.', '$');
+        itemId = itemIdRefInBuffer;
     }
     else {
         itemId = dataSetReference + 1;
@@ -2006,6 +2020,7 @@ IedConnection_getDataSetDirectory(IedConnection self, IedClientError* error, con
 
     *error = iedConnection_mapMmsErrorToIedError(mmsError);
 
+exit_function:
     return dataSetMembers;
 }
 
@@ -2014,7 +2029,7 @@ IedConnection_readDataSetValues(IedConnection self, IedClientError* error, const
         ClientDataSet dataSet)
 {
     char domainIdBuffer[65];
-    char itemIdBuffer[129];
+    char itemIdBuffer[DATA_SET_MAX_NAME_LENGTH + 1];
 
     const char* domainId = NULL;
     const char* itemId = NULL;
@@ -2023,7 +2038,21 @@ IedConnection_readDataSetValues(IedConnection self, IedClientError* error, const
 
     if (dataSetReference[0] != '@') {
         domainId = MmsMapping_getMmsDomainFromObjectReference(dataSetReference, domainIdBuffer);
-        char* itemIdRef = copyStringToBuffer(dataSetReference + strlen(domainId) + 1, itemIdBuffer);
+
+        if (domainId == NULL) {
+            *error = IED_ERROR_OBJECT_REFERENCE_INVALID;
+            goto exit_function;
+        }
+
+        const char* itemIdRefOrig = dataSetReference + strlen(domainId) + 1;
+
+        if (strlen(itemIdRefOrig) > DATA_SET_MAX_NAME_LENGTH) {
+            *error = IED_ERROR_OBJECT_REFERENCE_INVALID;
+            goto exit_function;
+        }
+
+        char* itemIdRef = copyStringToBuffer(itemIdRefOrig, itemIdBuffer);
+
         StringUtils_replace(itemIdRef, '.', '$');
         itemId = itemIdRef;
     }
@@ -2045,7 +2074,7 @@ IedConnection_readDataSetValues(IedConnection self, IedClientError* error, const
 
     if (dataSetVal == NULL) {
         *error = iedConnection_mapMmsErrorToIedError(mmsError);
-        goto cleanup_and_exit;
+        goto exit_function;
     }
     else
         *error = IED_ERROR_OK;
@@ -2059,7 +2088,7 @@ IedConnection_readDataSetValues(IedConnection self, IedClientError* error, const
         MmsValue_update(dataSetValues, dataSetVal);
     }
 
-cleanup_and_exit:
+exit_function:
     return dataSet;
 }