RasSetEntryDialParams

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

DWORD RasSetEntryDialParams(
  LPCTSTR lpszPhonebook, // pointer to the full path and file name of
                         // the phone book 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/2000: Pointer to a null-terminated string that specifies the full path and file name 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

Pointer to a RASDIALPARAMS structure containing the connection parameters to be associated with the phone-book 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 phone-book 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 phone-book entry for the user specified by szUserName is removed regardless of the contents of the szPassword string. Windows NT 4.0 and later: The password is changed to the string specified by szPassword regardless of whether szUserName is an empty string. Windows 2000 and later: If szPassword contains the password handle returned by RasGetCredentials or RasGetEntryDialParams, RasSetEntryDialParams returns successfully without changing any currently saved password.
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.
dwSubEntry	Specifies the (one-based) index of the initial subentry to dial when establishing the connection.
dwCallbackId	Not used; should be zero.

fRemovePassword

Specifies whether to remove the phone-book entry's stored password for the user specified by lprasdialparams->szUserName. If fRemovePassword is TRUE, the password is removed. Setting fRemovePassword to TRUE is equivalent to checking the "Unsave Password" checkbox in Dial-Up Networking. When setting the password or other properties of a phone book entry, set fRemovePassword to FALSE.

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.

Remarks

To create a new phone-book entry, use the RasSetEntryProperties function.

Requirements

  Windows NT/2000: Requires Windows NT 3.1 or later.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Ras.h.
  Library: Use Rasapi32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000.

See Also

Remote Access Service (RAS) Overview, Remote Access Service Functions, RASDIALPARAMS, RasCreatePhonebookEntry, RasEditPhonebookEntry, RasGetEntryDialParams, RasSetEntryProperties