{"id":328,"date":"2009-07-23T13:44:13","date_gmt":"2009-07-23T11:44:13","guid":{"rendered":"http:\/\/mariusbancila.ro\/blog\/?p=328"},"modified":"2011-05-20T15:56:34","modified_gmt":"2011-05-20T13:56:34","slug":"net-out-string-to-automation-safearray","status":"publish","type":"post","link":"https:\/\/mariusbancila.ro\/blog\/2009\/07\/23\/net-out-string-to-automation-safearray\/","title":{"rendered":".NET out string[] to Automation SAFEARRAY**"},"content":{"rendered":"

.NET allows you to expose components as COM and consume them from unmanaged code. There are many references on how to this (and you can only start with MSDN<\/a>), and I will not talk about that part. What I want to explain here is something different. Suppose you have this interface:<\/p>\n

\r\n[Guid(\"2F8433FE-4771-4037-B6B2-ED5F6585ED04\")]\r\n[InterfaceType(ComInterfaceType.InterfaceIsIDispatch)]\r\npublic interface IAccounts\r\n{\r\n      [DispId(1)]\r\n      string[] GetUsers();\r\n}\r\n<\/pre>\n
Method GetUsers() returns an array on string representing the user names. But what if you also wanted the user passwords or addresses? Since this is exposed as COM, you cannot return an array of User. But you can return multiple arrays of string. So, how would you deal with out string[]? This is what I want to show you in this tutorial.<\/p>\n
This is a .NET interface exposed to COM. It has two methods, GetUsers() that returns an array of string representing user names, and GetUsers2() that returns an array of strings as an output parameters and a bool as return type, indicating whether any user was found.<\/p>\n
\r\nnamespace SampleLibrary\r\n{\r\n   [Guid(\"2F8433FE-4771-4037-B6B2-ED5F6585ED04\")]\r\n   [InterfaceType(ComInterfaceType.InterfaceIsIDispatch)]\r\n   public interface IAccounts\r\n   {\r\n      [DispId(1)]\r\n      string[] GetUsers();\r\n\r\n      [DispId(2)]\r\n      bool GetUsers2(out string [] users);\r\n   }\r\n}\r\n<\/pre>\n
And this is the implementation:<\/p>\n
\r\nnamespace SampleLibrary\r\n{\r\n   [Guid(\"C4713144-5D29-4c65-BF9C-188B1B7CD2B6\")]\r\n   [ClassInterface(ClassInterfaceType.None)]\r\n   [ProgId(\"SampleLibrary.DataQuery\")]\r\n   public class Accounts : IAccounts\r\n   {\r\n      List< string > m_users;\r\n\r\n      public Accounts()\r\n      {\r\n         m_users = new List< string > {\r\n            \"marius.bancila\",\r\n            \"john.doe\",\r\n            \"anna.kepler\"\r\n         };\r\n      }\r\n\r\n      #region IDataQuery Members\r\n\r\n      public string[] GetUsers()\r\n      {\r\n         return m_users.ToArray();\r\n      }\r\n\r\n      public bool GetUsers2(out string[] users)\r\n      {\r\n         users = m_users.ToArray();\r\n\r\n         return users.Length > 0;\r\n      }\r\n\r\n      #endregion\r\n   }\r\n}\r\n<\/pre>\n
Note: If you are trying this example make sure you set the ComVisible attribute to true, either for each type or per assembly (in AssemblyInfo.cs)<\/p>\n
\r\n[assembly: ComVisible(true)]\r\n<\/pre>\n
Second, you have to check the “Register for COM interop” setting in the Build page of the project properties.<\/p>\n
The first thing to do in C++ is importing the .TLB file that was generated by regasm.exe.<\/p>\n
\r\n#import \"SampleLibrary.tlb\"\r\nusing namespace SampleLibrary;\r\n<\/pre>\n
If we look in the .TLB file, we can see how the IAccounts interface looks like:<\/p>\n
\r\nstruct __declspec(uuid(\"2f8433fe-4771-4037-b6b2-ed5f6585ed04\"))\r\nIAccounts : IDispatch\r\n{\r\n    \/\/\r\n    \/\/ Wrapper methods for error-handling\r\n    \/\/\r\n\r\n    \/\/ Methods:\r\n    SAFEARRAY * GetUsers ( );\r\n    VARIANT_BOOL GetUsers2 (\r\n        SAFEARRAY * * users );\r\n};\r\n<\/pre>\n
The following C++ functions, GetUsers1() retrieves the users users list using method GetUsers() from IAccounts. It puts the users in a CStringArray (notice that this container does not have an assignment operator, so the only way to return such an array is with a reference in the parameters list).<\/p>\n
\r\nvoid GetUsers1(CStringArray& arrUsers)\r\n{\r\n   IAccountsPtr pAccounts(__uuidof(Accounts));\r\n\r\n   SAFEARRAY* sarrUsers = pAccounts->GetUsers();\r\n\r\n   _variant_t varUsers;\r\n   varUsers.parray = sarrUsers;\r\n   varUsers.vt = VT_ARRAY | VT_BSTR;\r\n\r\n   UnpackBstrArray(varUsers, arrUsers);\r\n   SafeArrayDestroy(sarrUsers);\r\n\r\n   pAccounts->Release();\r\n}\r\n<\/pre>\n
UnpackBstrArray() is a function (see below) that extracts the elements of a SAFEARRAY and adds them to a CStringArray.<\/p>\n
Function GetUsers2() uses the second method, GetUsers2() from IAccounts. This needs the address of a pointer to a SAFEARRAY (i.e. SAFEARRAY**) that will hold the values returned by the COM method. This time we have to create an empty SAFEARRAY and then pass its address to the COM method. The rest is similar to the previous case.<\/p>\n
\r\nvoid GetUsers2(CStringArray& arrUsers)\r\n{\r\n   IAccountsPtr pAccounts(__uuidof(Accounts));\r\n\r\n   SAFEARRAYBOUND aDim[1];\r\n   aDim[0].lLbound = 0;\r\n   aDim[0].cElements = 0;\r\n\r\n   SAFEARRAY* sarrUsers = SafeArrayCreate(VT_BSTR, 1, aDim);\r\n\r\n   VARIANT_BOOL ret = pAccounts->GetUsers2(&sarrUsers);\r\n   if(ret != VARIANT_FALSE)\r\n   {\r\n      _variant_t varUsers;\r\n      varUsers.parray = sarrUsers;\r\n      varUsers.vt = VT_ARRAY | VT_BSTR;\r\n      UnpackBstrArray(varUsers, arrUsers);\r\n   }\r\n\r\n   SafeArrayDestroy(sarrUsers);\r\n\r\n   pAccounts->Release();\r\n}\r\n<\/pre>\n
The helper method UnpackBstrArray() used previous looks like this:<\/p>\n
\r\nvoid UnpackBstrArrayHelper(VARIANT* pvarArrayIn, CStringArray* pstrarrValues)\r\n{\r\n   if (!pstrarrValues || !pvarArrayIn || pvarArrayIn->vt == VT_EMPTY)\r\n      return;\r\n\r\n   pstrarrValues->RemoveAll();\r\n\r\n   VARIANT* pvarArray = pvarArrayIn;\r\n   SAFEARRAY* parrValues = NULL;\r\n\r\n   SAFEARRAYBOUND arrayBounds[1];\r\n   arrayBounds[0].lLbound = 0;\r\n   arrayBounds[0].cElements = 0;\r\n\r\n   if((pvarArray->vt & (VT_VARIANT|VT_BYREF|VT_ARRAY)) == (VT_VARIANT|VT_BYREF) && \r\n      NULL != pvarArray->pvarVal && \r\n      (pvarArray->pvarVal->vt & VT_ARRAY))\r\n   {\r\n      pvarArray = pvarArray->pvarVal;\r\n   }\r\n\r\n   if (pvarArray->vt & VT_ARRAY)\r\n   {\r\n      if (VT_BYREF & pvarArray->vt)\r\n         parrValues = *pvarArray->pparray;\r\n      else\r\n         parrValues = pvarArray->parray;\r\n   }\r\n   else\r\n      return;\r\n\r\n   if (parrValues != NULL)\r\n   {\r\n      HRESULT hr = SafeArrayGetLBound(parrValues, 1, &arrayBounds[0].lLbound);\r\n      hr = SafeArrayGetUBound(parrValues, 1, (long*)&arrayBounds[0].cElements);\r\n      arrayBounds[0].cElements -= arrayBounds[0].lLbound;\r\n      arrayBounds[0].cElements += 1;\r\n   }\r\n\r\n   if (arrayBounds[0].cElements > 0)\r\n   {\r\n      for (ULONG i = 0; i < arrayBounds[0].cElements; i++)\r\n      {\r\n         LONG lIndex = (LONG)i;\r\n         CString strValue = _T(\"\");\r\n\r\n         VARTYPE vType;\r\n         BSTR bstrItem;\r\n\r\n         ::SafeArrayGetVartype(parrValues, &vType);\r\n         HRESULT hr = ::SafeArrayGetElement(parrValues, &lIndex, &bstrItem);\r\n\r\n         if(SUCCEEDED(hr))\r\n         {\r\n            switch(vType)\r\n            {\r\n            case VT_BSTR:\r\n               strValue = (LPCTSTR)bstrItem;\r\n               break;\r\n            }\r\n\r\n            ::SysFreeString(bstrItem);\r\n         }\r\n\r\n         pstrarrValues->Add(strValue);\r\n      }\r\n   }\r\n}\r\n\r\nvoid UnpackBstrArray( const _variant_t &var, CStringArray &strarrValues  )\r\n{\r\n   UnpackBstrArrayHelper( &(VARIANT)const_cast< _variant_t & >(var), &strarrValues );\r\n}\r\n<\/pre>\n
Attached you can find a demo project (C# and C++) with the complete example show in this tutorial.<\/p>\n
\n\n\toutput SAFEARRAY** example\t(4871 downloads<\/span>\n\t)\n<\/a>\n<\/div>\n\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
.NET allows you to expose components as COM and consume them from unmanaged code. There are many references on how to this (and you can only start with MSDN), and I will not talk about that part. What I want to explain here is something different. Suppose you have this interface: [Guid(“2F8433FE-4771-4037-B6B2-ED5F6585ED04”)] [InterfaceType(ComInterfaceType.InterfaceIsIDispatch)] public interface … Read more<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_uag_custom_page_level_css":"","advgb_blocks_editor_width":"","advgb_blocks_columns_visual_guide":"","_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_feature_clip_id":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2},"jetpack_post_was_ever_published":false},"categories":[11,7,12,38,8],"tags":[454,451,461,453,275,276],"class_list":["post-328","post","type-post","status-publish","format-standard","hentry","category-csharp","category-c","category-mfc","category-tutorials","category-windows-programming","tag-net","tag-c","tag-com","tag-mfc","tag-safearray","tag-tutorial"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t