LoadTCHAR function

The LoadTCHAR function is called by monitors to set a string variable to a string taken from an HTML configuration string.

Syntax

BOOL LoadTCHAR(
  _In_  const char *pConfig,
  _In_  const char *pVarName,
  _Out_       char **ppszString
);

Parameters

pConfig [in]

Pointer to the HTML configuration string passed to the monitor by the IMonitor::DoConfigure method.

pVarName [in]

Pointer to the name of the variable in the configuration string.

ppszString [out]

Pointer to a string pointer. If the requested variable name is found, the string is allocated and assigned to this pointer. It is the user's responsibly to free the memory associated with the string.

Return value

If the function is successful (if the variable name was found and had a non-zero-length string), the return value is TRUE.

If the function is unsuccessful, the return value is FALSE.

Requirements

Requirement Value
Minimum supported client
Windows 2000 Professional [desktop apps only]
Minimum supported server
Windows 2000 Server [desktop apps only]
Header
Netmon.h
Library
Nmapi.lib
DLL
Nmapi.dll