ConfigurationManager.ProcessConfiguration Method

Article
03/29/2010

3/29/2010

Sends a device configuration XML file to Configuration Manager for processing.

Namespace: Microsoft.WindowsMobile.Configuration
Assembly: Microsoft.WindowsMobile.Configuration (in microsoft.windowsmobile.configuration.dll)

Syntax

public static XmlDocument ProcessConfiguration (
    XmlDocument configDoc,
    bool metadata
)

'Declaration
Public Shared Function ProcessConfiguration ( _
    configDoc As XmlDocument, _
    metadata As Boolean _
) As XmlDocument

Parameters

configDoc
The configuration document used to provision the device.

metadata
true to return metadata associated with the XML parm elements in the new configuration; otherwise, false. If false, then configDoc is returned.

Return Value

If metadata was not requested, ProcessConfiguration simply returns the original device configuration XML file - but if metadata was requested, then ProcessConfiguration returns the original device configuration XML file, but with additional XML markup that describes any processing errors.

Remarks

When a failure occurs, and an XML document is returned, be sure to parse the XML document for errors.

Example

This example shows how to call ProcessConfiguration to set a new Browser Favorite in Internet Explorer Mobile.

XmlDocument configDoc = new XmlDocument();
configDoc.LoadXml(
    "<wap-provisioningdoc>"+
    "<characteristic type=\"BrowserFavorite\">"+
    "<characteristic type=\"Microsoft\">"+
    "<parm name=\"URL\" value=\"https://www.microsoft.com\"/>"+
    "</characteristic>"+
    "</characteristic>"+
    "</wap-provisioningdoc>"
    );
ConfigurationManager.ProcessConfiguration(configDoc, false);

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.