RasCustomDialFn callback function (ras.h)

Article
02/22/2024

[This function is not available as of Windows Server 2008.

]

The RasCustomDial function is an application-defined function that is exported by a third-party custom-dialing DLL. This function allows third-party vendors to implement custom remote-access dialing routines.

Syntax

RasCustomDialFn Rascustomdialfn;

DWORD Rascustomdialfn(
  HINSTANCE hInstDll,
  LPRASDIALEXTENSIONS lpRasDialExtensions,
  LPCWSTR lpszPhonebook,
  LPRASDIALPARAMS lpRasDialParams,
  DWORD dwNotifierType,
  LPVOID lpvNotifier,
  LPHRASCONN lphRasConn,
  DWORD dwFlags
)
{...}

Parameters

hInstDll

Handle to the instance of the custom-dial DLL that was loaded.

lpRasDialExtensions

Pointer to a RASDIALEXTENSIONS structure that specifies a set of RasDial extended features to enable. Set this parameter to NULL if there is no need to enable the extensions.

lpszPhonebook

Pointer to a null-terminated string that specifies the full path and file name of a phone-book (PBK) file. If this parameter is NULL, the function uses the current default phone-book file. The default phone-book file is the one selected by the user in the User Preferences property sheet of the Dial-Up Networking dialog box.

lpRasDialParams

Pointer to a RASDIALPARAMS structure that specifies calling parameters for the RAS connection.

The caller must set the RASDIALPARAMS structure's dwSize member to sizeof(RASDIALPARAMS) to identify the version of the structure being passed.

dwNotifierType

This parameter is the same as the dwNotifierType parameter for the RasDial function. See the RasDial reference page for more information.

lpvNotifier

This parameter is the same as the lpvNotifier parameter for the RasDial function. See the RasDial reference page for more information.

lphRasConn

Pointer to a variable of type HRASCONN. Set the HRASCONN variable to NULL before calling RasDial. If RasDial succeeds, it stores a handle to the RAS connection into *lphRasConn.

dwFlags

This parameter reserved for future use.

Return value

If the function succeeds, the return value is ERROR_SUCCESS and a handle to the RAS connection in the variable pointed to by the lphRasConn parameter is returned.

If the function fails, the return value is one of the following error codes or a value from Routing and Remote Access Error Codes or Winerror.h.

Value	Meaning
ERROR_NOT_ENOUGH_MEMORY	The function could not allocate sufficient memory to complete the operation.

Remarks

RAS calls this entry point from RasDial, if the szCustomDialDll member of the RASENTRY structure for the entry being dialed specifies a custom-dialing DLL.

If this entry point calls RasDial, the lpRasDialExtensions parameter must not be NULL, and the dwFlags member of the RASDIALEXTENSIONS structure must have the RDEOPT_CustomDial flag set.

If the custom-dial DLL does not support this entry point, RAS returns ERROR_CANNOT_DO_CUSTOMDIAL to the caller of RasDial.

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