TelnetLogin Function  
 
BOOL WINAPI TelnetLogin(
  HCLIENT hClient,  
  LPCTSTR lpszUserName,  
  LPCTSTR lpszPassword  
);

The TelnetLogin function attempts to authenticate the user and log them in to the current session.

Parameters

hClient
Handle to the client session.
lpszUserName
A pointer to a string which specifies the name of the user to authenticate.
lpszPassword
A pointer to a string which specifies the password to be used when authenticating the user. If the user does not require a password, this parameter may be NULL.

Return Value

If the function succeeds, the return value is non-zero. If the function fails, the return value is zero. To get extended error information, call TelnetGetLastError.

Remarks

The TelnetLogin function is used to authenticate a user, logging them into the server. This function is specifically designed to work with most UNIX based servers, and may work with other servers that use a similar login process. The function works by scanning the data stream for a username prompt and then replying with the specified username. If that is successful, it will then scan for a password prompt and provide the specified password. If no recognized prompt is found, or if the server responds with an error indicating that the username or password is invalid, the function will fail.

If the TelnetLogin function succeeds, the next call to TelnetRead by the client will return any welcome message to the user. This is typically followed by a command prompt where the user can enter commands to be executed on the server. The data sent by the server during the login process is discarded and not available when the function returns. If the client requires this information, use the TelnetSearch function to automate the login process instead.

Because the TelnetLogin function is designed for UNIX based systems, it may not work with servers running on other operating system platforms such as Windows or VMS. In this case, applications should use the TelnetSearch function to search for the appropriate login prompts in the data stream.

Requirements

Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools10.h
Import Library: cstntv10.lib
Unicode: Implemented as Unicode and ANSI versions.

See Also

TelnetAsyncConnect, TelnetConnect, TelnetIsConnected, TelnetIsReadable, TelnetRead, TelnetSearch