RASADFunc
[New
- Windows NT]
The RASADFunc
function is an application-defined callback function that you can use to
provide a customized user interface for autodialing.
BOOL WINAPI RASADFunc(
LPTSTR lpszPhonebook, |
// pointer to full path
and filename of phone-book file |
LPTSTR lpszEntry, |
// pointer to the
entry name to validate |
LPRASADPARAMS lpAutodialParams, |
// pointer to a
RASADPARAMS structure |
LPDWORD lpdwRetCode |
// receives results
of dialing operation |
); |
|
Parameters
lpszPhonebook
Windows
NT: Pointer to a null-terminated
string that specifies the full path and filename 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.
lpszEntry
Pointer to a
null-terminated string that specifies the phone-book entry to use.
lpAutoDialParams
Pointer to a RASADPARAMS
lpdwRetCode
Pointer to a
variable in which you must return a value if you perform 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 your
application performs the dialing operation, return TRUE. Use the lpdwRetCode
parameter to indicate the results of the dialing operation.
If your
application does not perform the dialing operation, return FALSE. In this case,
the system uses the default user interface for dialing.
Remarks
When the
system starts an AutoDial operation for a phone-book entry with a custom
AutoDial handler, it calls the specified RASADFunc. Your RASADFunc
can start a thread to perform the custom dialing operation. The RASADFunc
function returns TRUE to indicate that it took over the dialing, or FALSE to
allow the system to perform the dialing.
If your RASADFunc
function performs the dialing operation, it presents its own user interface for
dialing and calls the RasDial function to do the actual dialing. Your RASADFunc
then returns TRUE to indicate that it took over the dialing. When the dialing
operation has been completed, set the variable pointed to by the lpdwRetCode
parameter to indicate success or failure.
Your AutoDial
DLL must provide both a RASADFUNCA (ANSI) and a RASADFUNCW
(Unicode) version of the RASADFunc handler. To enable a RASADFunc
AutoDial 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 szAutodialFunc member
should not include the A or W suffix.
RASADFunc is a placeholder for the library-defined function
name. The RASADFUNC type is a pointer to a RASADFunc function.
See Also