ORASADFunc

The ORASADFunc function is an application-defined callback function that you can use to provide a customized user interface for autodialing.

This prototype is provided for compatibility with earlier versions of Windows. New applications should use the RASADFunc callback function. Support for this prototype may be removed in future versions of RAS.

BOOL WINAPI ORASADFunc(
  HWND hwndOwner,       // handle of an owner window
  LPSTR lpszEntry,      // pointer to a phone-book entry
  DWORD dwFlags,        // reserved; must be zero
  LPDWORD lpdwRetCode   // receives the results of a dialing operation
);

Parameters

hwndOwner

Handle of the owner window.

lpszEntry

Pointer to a null-terminated string that specifies the phone-book entry to use.

dwFlags

Reserved; must be zero.

lpdwRetCode

Pointer to a variable that the callback function fills in with the results of the dialing operation. If the dialing operation succeeds, set this variable to ERROR_SUCCESS. If the dialing operation fails, set it to a nonzero value.

Return Values

If the callback function performs the dialing operation, return TRUE. Use the lpdwRetCode parameter to indicate the results of the dialing operation.

If the callback function does not perform the dialing operation, return FALSE. In this case, the system uses the default user interface for dialing.

Remarks

If your ORASADFunc function performs the dialing operation, it presents its own user interface for dialing and calls the RasDial function to do the actual dialing. Your ORASADFunc then returns TRUE to indicate that it took over the dialing. When the dialing operation has been completed, set the variable pointed to by lpdwRetCode to indicate success or failure.

To enable an ORASADFunc handler for a phone-book entry, use the RASENTRY structure in a call to the RasSetEntryProperties function. The szAutodialDll member specifies the name of the DLL that contains the handler, and the szAutodialFunc member specifies the exported name of the handler.

The ORASADFunc function is a placeholder for the library-defined function name. The ORASADFUNC type is a pointer to an ORASADFunc function.

Requirements

  Windows NT/2000: Requires Windows NT 3.1 or later.
  Windows 95/98: Unsupported.
  Header: Declared in Ras.h.

See Also

Remote Access Service (RAS) Overview, Remote Access Service Functions, RASADFunc, RasDial, RASENTRY, RasSetEntryProperties