TranSetParam
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/27/2008
This function passes a parameter name and value. The kitldll.dll library calls the TranSetParam function for each parameter in the XML string.
To use the XML grid in a custom transport, you must support the TranGetXMLParams function and the TranSetParam function.
Syntax
BOOL TranSetParam(
LPCWSTR strName,
LPCWSTR strValue,
LPWSTR pstrError,
long lErrorStringSize
);
Parameters
- strName
[in] Name of the parameter.
- strValue
[in] Value of the parameter.
- pstrError
[in, out] Pointer to the error string.
- lErrorStringSize
[in] Size of the error string.
Return Value
This function returns TRUE if there is no validation error. If the TranSetParam function returns FALSE, the pstrError parameter points to the error string.
Remarks
The XML grid dialog box allocates memory for the error string. The lErrorStringSize parameter contains the size, including the terminating nul character, allocated for the error string. Do not overwrite the array in reporting an error.
On the transport side, the implementation of the TranSetParam function does not require knowledge of XML.
Requirements
| Header | kitltran.h |
| Windows Embedded CE | Windows CE .NET 4.0 and later |