Share via

TranGetXMLParams

  • Article

This function obtains the properties that you want to expose in the dialog box that configures settings for a kernel transport in the Platform Builder integrated development environment (IDE). This function builds an Extensible Markup Language (XML) string and returns the string to the XML grid. The Kitldll.dll library calls this function when you choose Configure after selecting a kernel transport in the Configure Remote Connection dialog box.

BOOL TranGetXMLParams(
  LPCWSTR* ppstrXML 
);

Parameters

  • ppstrXML
    [in, out] Pointer to a pointer to the XML string.

Return Values

This function returns TRUE if the XML string can be written or FALSE if XML string cannot be written.

Remarks

For the complete syntax of the XML string, see XML Grid Schema.

To use the XML grid in a custom transport, you must support the TranGetXMLParams function and the TranSetParam function.

Platform Builder creates a dialog box with controls based on the XML string returned by the TranGetXMLParams function. When you choose OK in the dialog box, Platform Builder calls the TranSetParam function for each property in the dialog box.

The XML grid validates the XML string. Validation is not required at the transport level. The XML string returned by the TranGetXMLParams function is a constant.

Do not de-allocate memory returned by the ppstrXML pointer.

Requirements

OS Versions: Windows CE .NET 4.0 and later.
Header: KitlTran.h.

See Also

Adding Support for the XML Grid to a Transport

 Last updated on Friday, October 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.