RASDIALFUNC1 callback function (ras.h)

A RasDialFunc1 function is called by the RasDial function when a change of state occurs during a remote access connection process. A RasDialFunc1 function is comparable to a RasDialFunc function, but is enhanced by the addition of two parameters: a handle to the RAS connection, and an extended error code.

Syntax

RASDIALFUNC1 Rasdialfunc1;

void Rasdialfunc1(
  HRASCONN unnamedParam1,
  UINT unnamedParam2,
  tagRASCONNSTATE unnamedParam3,
  DWORD unnamedParam4,
  DWORD unnamedParam5
)
{...}

Parameters

unnamedParam1

unnamedParam2

unnamedParam3

unnamedParam4

unnamedParam5

Return value

None

Remarks

A RasDial connection operation is suspended during a call to a RasDialFunc1 callback function. For that reason, the RasDialFunc1 implementation generally returns as quickly as possible. There are two exceptions to that rule. Asynchronous (slow) devices such as modems often have time-out periods measured in seconds rather than milliseconds; a slow return from a RasDialFunc1 function is generally not a problem. The prompt return requirement also does not apply when dwError is nonzero, indicating that an error has occurred. It is safe, for example, to put up an error dialog box and wait for user input.

The RasDialFunc1 implementation should not depend on the order or occurrence of particular RASCONNSTATE connection states, because this may vary between platforms.

Do not call the RasDial function from within a RasDialFunc1 callback function. Call the RasGetConnectStatus, RasEnumEntries, RasEnumConnections, RasGetErrorString, and RasHangUp functions from within the callback function. For example, calling RasGetConnectStatus from within a callback function would be useful for determining the name and type of the connecting device.

Note that, for convenience, RasHangUp can be called from within a RasDialFunc1 callback function. However, much of the hang-up processing occurs after the RasDialFunc1 callback function has returned.

RasDialFunc1 is a placeholder for the application-defined or library-defined function name.

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 ras.h

See also

RASCONNSTATE

RasDial

RasDialFunc

RasDialFunc2

RasEnumConnections

RasEnumEntries

RasGetConnectStatus

RasGetErrorString

RasHangUp

Remote Access Service (RAS) Overview

Remote Access Service Functions