Device Configuration Using .NET CF

[Robert Levy]

The Smartphone includes some cool features under the covers that allow mobile operators, enterprises, and developers to make configuration changes to a device using XML. This XML can be sent to the device over the air, through a desktop, and through custom applications running on the device. Accessing this functionality from applications written in C++ is pretty straightforward using the DMProcessConfigXML function. However, doing this from a .NET Compact Framework app requires a bit of work. Version 2 of of the Compact Framework will make this really easy but in the mean time, feel free to use my C# DMProcessConfigXML wrapper. This works on Smartphone 2003 and Pocket PC 2003.

using System;using System.Runtime.InteropServices;namespace DeviceConfigLib{	public enum ConfigFlag : uint	{		/// <summary>		/// The configuration management service and the 		/// Configuration Service Providers (CSPs) process		/// the input data.		/// </summary>		Process = 1,		/// <summary>		/// The configuration management service gathers 		/// and returns metadata for any XML parm elements 		/// it encounters.		/// </summary>		Metadata = 2	}	public class ConfigWrapper	{		[DllImport("aygshell.dll")]		private extern static UInt32 DMProcessConfigXML( string xmlIn, UInt32 flag, out IntPtr xmlOutPtr );		[DllImport("coredll.dll")]		private extern static IntPtr LocalFree( IntPtr hMem );			public static string ProcessXml( string xml )		{			return ProcessXml( xml, ConfigFlag.Process );		}		/// <summary>		/// This function wraps acts as a managed interface to the 		/// DMProcessConfigXML in Pocket PC 2003+ and Smartphone 2002+		/// The DMProcessConfigXML function grants remote access to the		/// configuration management functionality of the mobile device. 		/// This function enables the submission of Extensible Markup 		/// Language (XML) information that causes the settings of a 		/// mobile device to change.  See "Configuration Service Providers" 		/// in the API for details on the XML schema.		/// </summary>		/// <param name="xml">		/// String of valid XML containing configuration data		/// </param>		/// <param name="flag">		/// Action flag (see ConfigFlag for details)		/// </param>		/// <returns>		/// String of valid XML containing the result of this operation		/// </returns>		public static string ProcessXml( string xml, ConfigFlag flag )		{			IntPtr xmlOutPtr;			string xmlOutStr;			long result;			result = DMProcessConfigXML( xml, (uint)flag, out xmlOutPtr );            			// marshal the output string			xmlOutStr = Marshal.PtrToStringUni( xmlOutPtr );			// free the memory allocated by the API			LocalFree( xmlOutPtr );			// throw an exception if an error code was returned			if( result != 0 )			{				throw new ArgumentException( String.Format(					"DMProcessConfigXML returned error code {0}", result ), 					xml );			}			return xmlOutStr;		}	}}

Enjoy!

[Robert Levy]

The Smartphone includes some cool features under the covers that allow mobile operators, enterprises, and developers to make configuration changes to a device using XML. This XML can be sent to the device over the air, through a desktop, and through custom applications running on the device. Accessing this functionality from applications written in C++ is pretty straightforward using the DMProcessConfigXML function. However, doing this from a .NET Compact Framework app requires a bit of work. Version 2 of of the Compact Framework will make this really easy but in the mean time, feel free to use my C# DMProcessConfigXML wrapper. This works on Smartphone 2003 and Pocket PC 2003.

using System;using System.Runtime.InteropServices;namespace DeviceConfigLib{	public enum ConfigFlag : uint	{		/// <summary>		/// The configuration management service and the 		/// Configuration Service Providers (CSPs) process		/// the input data.		/// </summary>		Process = 1,		/// <summary>		/// The configuration management service gathers 		/// and returns metadata for any XML parm elements 		/// it encounters.		/// </summary>		Metadata = 2	}	public class ConfigWrapper	{		[DllImport("aygshell.dll")]		private extern static UInt32 DMProcessConfigXML( string xmlIn, UInt32 flag, out IntPtr xmlOutPtr );		[DllImport("coredll.dll")]		private extern static IntPtr LocalFree( IntPtr hMem );			public static string ProcessXml( string xml )		{			return ProcessXml( xml, ConfigFlag.Process );		}		/// <summary>		/// This function wraps acts as a managed interface to the 		/// DMProcessConfigXML in Pocket PC 2003+ and Smartphone 2002+		/// The DMProcessConfigXML function grants remote access to the		/// configuration management functionality of the mobile device. 		/// This function enables the submission of Extensible Markup 		/// Language (XML) information that causes the settings of a 		/// mobile device to change.  See "Configuration Service Providers" 		/// in the API for details on the XML schema.		/// </summary>		/// <param name="xml">		/// String of valid XML containing configuration data		/// </param>		/// <param name="flag">		/// Action flag (see ConfigFlag for details)		/// </param>		/// <returns>		/// String of valid XML containing the result of this operation		/// </returns>		public static string ProcessXml( string xml, ConfigFlag flag )		{			IntPtr xmlOutPtr;			string xmlOutStr;			long result;			result = DMProcessConfigXML( xml, (uint)flag, out xmlOutPtr );            			// marshal the output string			xmlOutStr = Marshal.PtrToStringUni( xmlOutPtr );			// free the memory allocated by the API			LocalFree( xmlOutPtr );			// throw an exception if an error code was returned			if( result != 0 )			{				throw new ArgumentException( String.Format(					"DMProcessConfigXML returned error code {0}", result ), 					xml );			}			return xmlOutStr;		}	}}

Enjoy!

[kcchesnut]

i didnt think .NETcf worked on SmartPhone 2002

[Peter Foot]

Originally Posted by kcchesnut

i didnt think .NETcf worked on SmartPhone 2002

Yep thats right, it has the same DMProcessConfigXML function - but no .NETCF - this wrapper is only suitable for Windows Mobile 2003 devices.

BTW, useful bit of code Robert!

[kcchesnut]

cool, i used it to do the standard BrowserFavorite demo.
Thanks for the code

[Eric Roijen]

Originally Posted by kcchesnut

cool, i used it to do the standard BrowserFavorite demo.
Thanks for the code

Can you post some code on how to use thes functions?
Like the one you mention, the BrowserFavorite?

Thanks.
Eric.

[ctitanic]

any VB .NET version of the code available.

[ctitanic]

Imports System
Imports System.Runtime.InteropServices

Namespace DeviceConfigLib

    Public Enum ConfigFlag As Integer
        Process = 1
        Metadata = 2
    End Enum

    Public Class ConfigWrapper

        <DllImport("aygshell.dll")> Private Function DMProcessConfigXML(ByVal xmlIn As String, ByVal flag As Integer, ByVal xmlOutPtr As IntPtr) As Integer
        End Function

        <DllImport("coredll.dll")> Private Function LocalFree(ByVal hMem As IntPtr) As IntPtr
        End Function

        Public Function ProcessXml(ByVal xml As String) As String
            Return ProcessXml(xml, ConfigFlag.Process)
        End Function

        ' <summary>
        ' This function wraps acts as a managed interface to the 
        ' DMProcessConfigXML in Pocket PC 2003+ and Smartphone 2002+
        ' The DMProcessConfigXML function grants remote access to the
        ' configuration management functionality of the mobile device. 
        ' This function enables the submission of Extensible Markup 
        ' Language (XML) information that causes the settings of a 
        ' mobile device to change.  See "Configuration Service Providers" 
        ' in the API for details on the XML schema.
        ' </summary>
        ' <param name="xml">
        ' String of valid XML containing configuration data
        ' </param>
        ' <param name="flag">
        ' Action flag (see ConfigFlag for details)
        ' </param>
        ' <returns>
        ' String of valid XML containing the result of this operation
        ' </returns>
        Public Function ProcessXml(ByVal xml As String, ByVal flag As ConfigFlag) As String

            Dim xmlOutPtr As IntPtr
            Dim xmlOutStr As String
            Dim result As Integer

            result = DMProcessConfigXML(xml, CType(flag, Integer), xmlOutPtr)

            ' marshal the output string
            xmlOutStr = Marshal.PtrToStringUni(xmlOutPtr)

            ' free the memory allocated by the API
            LocalFree(xmlOutPtr)

            ' throw an exception if an error code was returned
            If (result <> 0) Then
                Throw New ArgumentException(String.Format("DMProcessConfigXML returned error code {0}", result), xml)
            End If

            Return xmlOutStr
        End Function
    End Class
end namespace

this is giving an error.

[ctitanic]

disregard my previous post, we got it working.

[Mike Temporale]

Originally Posted by ctitanic

disregard my previous post, we got it working.

Cool. Glad we could help, kind of.... :wink: :lol:

[rsuresh]

Hi All,
I was trying to use Roberts code to change the smartphone ringtone to vibrate? However, It returns the error don't think it likes my XML string statement.

The following is the exeception Visual Studio.nET returns:
$exception {"DMLProcessConfig.XML returned error code2147753993" }System.ArgumentException

My code is as follows

namespace MyProject
{
	class Application
	{
		public static void Main()
		{
			string temp;
			string xmlQuery
                                  ="<wapprovisioningdoc>"+
		             "<characteristic type=\"Sounds\">"+
                             "<characteristic type=\"HKCU\\ControlPanel\\Sounds\\Ringtone0\">"+
                             "<parm name=\"Sound\" value=av3w3r/>"+ 
                             "</characteristic>"+
                             "</characteristic>"+
                             "</wap-provisioningdoc>";

			
	           	temp=ConfigWrapper.ProcessXml(xmlQuery);
		MessageBox.Show(temp);
		    
	
		}//end main
	}//end class application
}//end namespace myproject

Please tell me i'm doing something fudmentally wrong.

Also as an aside could someone please post an emaple showing how to query the metatags using the Config wrapper.

Cheers

Ro