Export (0) Print
Expand All

ORASADFunc callback function

The ORASADFunc function is an application-defined callback function that is used 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.

Syntax


BOOL WINAPI ORASADFunc(
  _In_  HWND hwndOwner,
  _In_  LPSTR lpszEntry,
  _In_  DWORD dwFlags,
  _In_  LPDWORD lpdwRetCode
);

Parameters

hwndOwner [in]

Handle of the owner window.

lpszEntry [in]

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

dwFlags [in]

Reserved; must be zero.

lpdwRetCode [in]

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 value

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 the ORASADFunc function performs the dialing operation, it presents its own user interface for dialing and calls the RasDial function to do the actual dialing. The 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 szAutodialDll 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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Ras.h

See also

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

 

 

Community Additions

ADD
Show:
© 2014 Microsoft