Skip to main content

Marshalling strings with StringBuilder

The dotNet framework is pretty smart when it comes to marshalling managed to unmanaged datatypes for PInvoke calls. When you want to pass a Guid from the managed to the unmanaged world the framework knows how to transform the .Net Guid structure to a Windows GUID without you even asking for it.

Marshalling strings is usually no problem either. You can pass in a managed string and the .Net framework handles any unicode to ANSI conversions for you.

   1: [DllImport("setupapi.dll", CharSet = CharSet.Auto, SetLastError = true)]
   2: public static extern bool SetupDiClassGuidsFromName(
   3:     string className, ref Guid guids, UInt32 classGuidListSize, ref UInt32 requiredSize);
   4:  
   5: [DllImport("setupapi.dll", CharSet = CharSet.Auto, SetLastError = true)]
   6: public static extern bool SetupDiClassNameFromGuid( 
   7:     ref Guid classGuid, string className, UInt32 classNameSize, ref UInt32 requiredSize);

These two calls from the setupapi.dll library illustrate this. The first call takes a string describing a device-class (for example keyboard) and returns an array of Guids with usually one Guid for that device class (4D36E96B-E325-11CE-BFC1-08002BE10318 for keyboards). The classGuidListSize parameter tells the dll how big we made the guids array. If it's not big enoug we can check the requiredSize parameter after the call and call again with a bigger array.


The second call is a problem though. It's exactly the reverse of the first call. It takes a single Guid and returns a string. The problem here is that in the managed world we dont have much influence over the size of strings. That's all handled for us.


One hack could be to pass in an empty string, with zero in classNameSize, and pass in a string padded with the appropriate amount of spaces the second time around to make it big enoug to hold the amount of characters in requiredSize but that would be a bit messy.


The preferred way is to pass in a StringBuilder class instead of a string. We can use the Capacity property of the StringBuilder to make it any size we want.



   1: [DllImport("setupapi.dll", CharSet = CharSet.Auto, SetLastError = true)]
   2: public static extern bool SetupDiClassNameFromGuid( 
   3:     ref Guid classGuid, StringBuilder className, UInt32 classNameSize, ref UInt32 requiredSize);
   4:             
   5: public string ClassNameFromGuidWrapper(Guid classGuid)
   6: {
   7:     // 50 is a Sensible default value, if we're lucky it's enough
   8:     uint reqSize = 50;
   9:     StringBuilder classNameBuilder = new StringBuilder((int)reqSize);
  10:  
  11:     // First try.
  12:     returnValue = _SetupApi.SetupDiClassNameFromGuid(
  13:         ref classGuid, classNameBuilder, (uint)classNameBuilder.Capacity, ref reqSize);
  14:  
  15:     if ((uint)classNameBuilder.Capacity != reqSize)
  16:     {
  17:         // call again with the right size stringbuilder
  18:         classNameBuilder.Capacity = (int)reqSize;
  19:         returnValue = _SetupApi.SetupDiClassNameFromGuid(
  20:             ref classGuid, classNameBuilder, reqSize, ref reqSize);
  21:     }
  22:  
  23:     return classNameBuilder.ToString();
  24: }

Comments

Popular posts from this blog

Using xUnit.Net with .Net 4.0

I’ve been using xUnit.Net for a while now. It’s just a tiny bit cleaner and slightly less abrasive than other .Net unit testing frameworks. Leaving out unnecessary stuff like [TestFixture] and shortening Assert.AreEqual to the equally clear but shorter Assert.Equal don’t seem like big improvements but when you type them several times a day tiny improvements start to add up. I also like the use of the [Fact] attribute instead of [Test]. It shifts the focus from testing to defining behavior. So how do we get all this goodness working with the Visual Studio 2010 beta?

Running a Git repository on Ubuntu using Gitosis

20I’ve been using Git for a couple of small projects that I’ve been hosting on github.com but version control for my bigger ‘secret’ projects still runs on a windows machine with visual svn server.Now that I’m starting to use Mono for a couple of projects so I’m playing with linux more. Last week I decided to try to try out gitosis on an ubuntu server. I found out it’s pretty easy to use when you know your way around git but for a noob like me some things weren’t immediately clear. Eventually I solved most problems I ran into, so I decided to write up the steps I took to install gitosis on ubuntu 10.04

Android development resource links

I've been playing with the Android SDK and I have a growing list of bookmarks to Android dev resources for my own use. I thought the best place to keep them would be here on my blog. That way other people can benefit too. I'll keep updating this list so feel free to add suggestions in the comments.