RasSetEntryDialParamsA function (ras.h)

Article
02/09/2023

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.

Syntax

DWORD RasSetEntryDialParamsA(
  [in] LPCSTR           unnamedParam1,
  [in] LPRASDIALPARAMSA unnamedParam2,
  [in] BOOL             unnamedParam3
);

Parameters

[in] unnamedParam1

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 Me/98/95: This parameter should always be NULL. Dial-up networking stores phone-book entries in the registry rather than in a phone-book file.

[in] unnamedParam2

Pointer to the RASDIALPARAMS structure that specifies the connection parameters to be associated with the phone-book entry. RasSetEntryDialParams uses the structure's members as follows.

Member	Meaning
dwSize	Must specify the size of (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 that contains the callback phone number. If szCallbackNumber is an empty string ( "" ), the callback number is not changed.
szUserName	A null-terminated string that contains 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 that contains 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: The password is changed to the string specified by szPassword regardless of whether szUserName is an empty string. Windows XP/2000: 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 that contains the name of the domain on which to log on. 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	Specifies an application-defined value that RAS passes to the RasDialFunc2 callback function.

[in] unnamedParam3

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

Return value

If the function succeeds, the return value is ERROR_SUCCESS.

If the function fails, the return value is one of the following error codes or a value from Routing and Remote Access Error Codes or Winerror.h.

Value	Description
ERROR_BUFFER_INVALID	The address or buffer specified by lprasdialparams 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.

Remarks

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

Windows XP or later: Do not use the RasSetEntryDialParams function. To set the credentials for a phone-book entry, use the RasSetCredentials function. Set the non-credential members of RASDIALPARAMS (for example szCallbackNumber, dwSubEntry, or dwCallbackId) directly in the RASDIALPARAMS structure passed as a parameter to the RasDial function.

Note

The ras.h header defines RasSetEntryDialParams as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	ras.h
Library	Rasapi32.lib
DLL	Rasapi32.dll