TranGetXMLParams (Compact 2013)
3/26/2014
This function obtains the properties that you want to expose in the dialog box that configures settings for a kernel transport in Platform Builder. 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 Settings after selecting a kernel transport in the Target Connectivity Options dialog box.
Syntax
BOOL TranGetXMLParams(
LPCWSTR* ppstrXML
);
Parameters
- ppstrXML
[in, out] Pointer to a pointer to the XML string.
Return Value
This function returns TRUE if the XML string can be written or FALSE if XML string cannot be written.
Remarks
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 deallocate memory returned by the ppstrXML pointer.
Requirements
Header |
kitltran.h |