Share via

DMProcessConfigXML

  • Article

The DMProcessConfigXML function grants local access to the configuration management functionality of the mobile device. This function enables the submission of Extensible Markup Language (XML) information to change the settings of a mobile device.

Syntax

HRESULT DMProcessConfigXML(
  LPCWSTR pszWXMLin, 
  DWORD dwFlags, 
  LPWSTR * ppszwXMLout
);

Parameters

  • pszWXMLin
    [in] The input XML buffer containing the configuration data.
  • dwFlags
    [in] Specifies an action flag. For more information, see Remarks.
  • ppszwXMLout
    [out] Long pointer to the output XML buffer. For more information, see Remarks.

Return Values

This function returns the standard values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following:

  • S_OK
    Indicates success.

Remarks

To avoid locking up the device, do not call DMProcessConfigXML from the DLL file specified in the CeSetupDLL entry of the [DefaultInstall] section of the .inf file used to create the .cab file.

The action flags specified by the dwFlags parameter are described in the following table.

Option Value Description
CFGFLAG_PROCESS 0x0001 The configuration management service and the Configuration Service Providers (CSPs) process the input data.
CFGFLAG_METADATA 0x0002 The configuration management service gathers and returns metadata for any XML parm elements it encounters.

The caller of DMProcessConfigXML is responsible for cleanup of the output buffer that the ppszwXMLout parameter references. Memory is allocated in the implementation by means of the new [] operator, so the caller must use the delete [] <varname> statement to free the output buffer.

The Configuration Manager component is transactional and must process only one configuration request at a time to prevent collisions. Therefore, the DMProcessConfigXML function processes only one XML configuration request at a time.

Requirements

Smartphone: Windows Mobile 2002 and later
OS Versions: Windows CE 3.0 and later
Header: cfgmgrapi.h
Library: aygshell.lib

Last updated on Friday, April 22, 2005

© 2005 Microsoft Corporation. All rights reserved.

Send feedback on this topic to the authors.