RasSetEntryDialParams
The RasSetEntryDialParams
function changes the connection information saved by the last successful call
to the RasDial
or RasSetEntryDialParams function for a specified phonebook entry.
DWORD RasSetEntryDialParams(
|
LPTSTR lpszPhonebook, |
// pointer to the
full path and filename of the phonebook file |
|
LPRASDIALPARAMS lprasdialparams, |
// pointer to a
structure with the new connection parameters |
|
BOOL fRemovePassword |
// indicates
whether to remove password from entry s parameters |
|
); |
|
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
phonebook entries in the registry rather than in a phonebook file.
lprasdialparams
Points to a RASDIALPARAMS structure containing the
connection parameters to be associated with the phonebook entry. RasSetEntryDialParams
uses the structure s members as follows:
|
Member |
Description |
|
dwSize |
Must
specify the sizeof(RASDIALPARAMS) to identify the version of the
structure. |
|
szEntryName |
A
null-terminated string that identifies the phonebook entry to set parameters
for. |
|
szPhoneNumber |
Not used.
Set to NULL. |
|
szCallbackNumber |
A
null-terminated string containing the callback phone number. If szCallbackNumber
is an empty string ( ), the callback number is not changed. |
|
szUserName |
A
null-terminated string containing the logon name of the user associated with
this entry. If szUserName is an empty string, the user name is not
changed. |
|
szPassword |
A
null-terminated string containing the password for the user specified by szUserName.
If szUserName is an empty string, the password is not changed. If szPassword
is an empty string and fRemovePassword is FALSE, the password is set
to the empty string. If fRemovePassword is TRUE, the password stored
in this phonebook entry for the user specified by szUserName is
removed regardless of the contents of the szPassword string. |
|
szDomain |
A null-terminated
string containing the name of the domain to log on to. If szDomain is
an empty string, the domain name is not changed. |
fRemovePassword
Indicates
whether to remove the phonebook entry s stored password for the user specified
by lprasdialparams->szUserName. If fRemovePassword is
TRUE, the password is removed.
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 address
or buffer specified by lprasdialparams is invalid. |
|
|
ERROR_CANNOT_OPEN_PHONEBOOK |
|
|
|
|
The
phonebook is corrupted or missing components. |
|
|
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY |
|
|
|
|
The
phonebook entry does not exist. |
|
See Also