Overview
Group
Quick Info

Windows NT
Yes
Win95
Yes
Win32s
No
Import Library
rasapi32.lib
Header File
ras.h
Unicode
No
Platform Notes
None

RasGetEntryDialParams

The RasGetEntryDialParams function retrieves the connection information saved by the last successful call to the RasDial or RasSetEntryDialParams function for a specified phone-book entry.

DWORD RasGetEntryDialParams(

LPTSTR lpszPhonebook,
// pointer to the full path and filename of the phone-book file
LPRASDIALPARAMS lprasdialparams,
// pointer to a structure that receives the connection parameters
LPBOOL lpfPassword
// indicates whether the user's password was retrieved
);

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.

Windows 95: Dial-up networking stores phone-book entries in the registry rather than in a phone-book file.

lprasdialparams

Points to a RASDIALPARAMS structure that receives the connection parameters associated with the phone-book entry specified by the szEntryName member. On entry, the dwSize member must specify the size of the RASDIALPARAMS structure, and the szEntryName member must specify a valid phone-book entry.

lpfPassword

Points to a flag that indicates whether the function retrieved the password associated with the user name for the phone-book entry. The function sets this flag to TRUE if the user's password was returned in the szPassword member of the RASDIALPARAMS structure pointed to by lprasdialparams.

Return Values

If the function succeeds, the return value is zero.

If the function fails, the return value can be one of the following error codes:

Value
Description
ERROR_BUFFER_INVALID


The lprasdialparams or lpfPassword pointer is invalid, or the lprasdialparams buffer is invalid.
ERROR_CANNOT_OPEN_PHONEBOOK


The phone book is corrupted or missing components.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY


The phone-book entry does not exist.

See Also

RasDial
, RASDIALPARAMS, RasCreatePhonebookEntry, RasEditPhonebookEntry, RasSetEntryDialParams

Software for developers
Delphi Components
.Net Components
Software for Android Developers
More information resources
MegaDetailed.Net
Unix Manual Pages
Delphi Examples
Databases for Amazon shops developers
Amazon Categories Database
Browse Nodes Database