RasSecurityDialogSend function (rasshost.h)

Article
10/13/2021

The RasSecurityDialogSend function sends a message to be displayed in a terminal window on a remote computer. A third-party RAS security DLL sends this message as part of its authentication of a remote user.

To call this function, first call the LoadLibrary function to load Rasman.dll. Then call the GetProcAddress function to get the DLL's RasSecurityDialogSend entry point.

Note Windows Server 2008, Windows Server 2003, Windows 2000 Server, and Windows NT Server 4.0 currently provide RAS security host support for serial devices only. Other types of connections, such as Integrated Services Digital Network (ISDN) or virtual private network (VPN) connections, are not supported.

Syntax

DWORD RasSecurityDialogSend(
  [in] HPORT hPort,
  [in] PBYTE pBuffer,
  [in] WORD  BufferLength
);

Parameters

[in] hPort

Specifies the port handle that the RAS server passed to the security DLL in the RasSecurityDialogBegin call for this authentication transaction.

[in] pBuffer

Pointer to the send buffer that was passed to the security DLL in the call to RasSecurityDialogBegin. Before calling RasSecurityDialogSend, copy into this buffer the message to send to the remote user. The SendBufSize parameter of the RasSecurityDialogBegin function indicates the maximum number of bytes the buffer can store.

[in] BufferLength

Specifies the number of bytes to send in the pBuffer buffer.

Return value

If the function is successful, the return value is PENDING (defined in Raserror.h). This indicates that the send operation is in progress.

If an error occurs, the return value is one of the error codes defined in Raserror.h or Winerror.h. GetLastError does not provide extended error information.

Remarks

The RasSecurityDialogSend function is asynchronous. After calling it to send a message to the remote user, call the RasSecurityDialogReceive function, and then wait for a response. The security DLL can make any number of RasSecurityDialogSend calls, with each call followed by a RasSecurityDialogReceive call.

When a security DLL is authenticating a remote user, the connection operation on the remote computer enters a RASCS_Interactive paused state. The message sent by RasSecurityDialogSend is displayed as output in a terminal window on the remote computer. The response received by RasSecurityDialogReceive is the input that the remote user types in the terminal window. The RASCS_Interactive value is defined in the RASCONNSTATE enumeration.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	rasshost.h
DLL	Rasman.dll