Platform SDK: RAS/Routing and RAS

RasPBDlgFunc

The RasPBDlgFunc function is an application-defined callback function that receives notifications of user activity while the RasPhonebookDlg dialog box is open.

VOID WINAPI RasPBDlgFunc(
  DWORD dwCallbackId,  // an application-defined value
  DWORD dwEvent,       // indicates the event that occurred
  LPTSTR pszText,      // pointer to an additional string argument
  LPVOID pData         // pointer to an additional buffer argument
);

Parameters

dwCallbackId
Specifies the application-defined value that was specified in the dwCallback member of the RASPBDLG structure passed to the RasPhonebookDlg function.
dwEvent
A set of bit flags that indicates the event that occurred. This parameter is one of the following values.
Value Meaning
RASPBDEVENT_AddEntry Received when the user creates a new phone-book entry or copies an existing phone-book entry. The pszText parameter is the name of the new or copied entry. The pData parameter is undefined.
RASPBDEVENT_EditEntry Received when the user changes an existing phone-book entry. The pszText parameter is the name of the modified entry. The pData parameter is undefined.
RASPBDEVENT_RemoveEntry Received when the user deletes a phone-book entry. The pszText parameter is the name of the deleted entry. The pData parameter is undefined.
RASPBDEVENT_DialEntry Received when the user successfully dials an entry. The pszText parameter is the name of the newly connected entry. The pData parameter is undefined.
RASPBDEVENT_EditGlobals Received when the user makes changes in the User Preferences property sheet. The pszText parameter is the full path of the default phone-book file selected by the user. The pData parameter is undefined.

This event is also received during dialog startup if the lpszPhonebook parameter of the RasPhonebookDlg call is NULL. In this case, the event informs the caller of the path of the default phone book.

RASPBDEVENT_NoUser Received during dialog box initialization when the RASPBDFLAG_NoUser flag is set. The pData parameter is a pointer to a RASNOUSER structure. The callback function should fill the structure with the user's logon credentials and dialog time out. The RasPhonebookDlg function then uses the supplied credentials for authentication by the remote server. The pszText parameter is undefined.
RASPBDEVENT_NoUserEdit Received if the RASPBDFLAG_NoUser flag is set and the user changes the credentials that you supplied during the RASPBDEVENT_NoUser event. The pData parameter is a pointer to a RASNOUSER structure containing the updated credentials. This occurs during a dialing operation if the user changes his or her password, or if the authentication fails and the user retries authentication with different credentials. The pszText parameter is undefined.

pszText
Pointer to an additional string argument whose meaning depends on the event indicated in the dwEvent parameter.
pData
Pointer to an additional buffer argument whose meaning depends on the event indicated in the dwEvent parameter.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 or later.
  Windows 95/98: Unsupported.
  Header: Declared in Rasdlg.h.
  Unicode: Declared as Unicode and ANSI prototypes.

See Also

Remote Access Service (RAS) Overview, Remote Access Service Functions, RASNOUSER, RasPhonebookDlg