Overview
Group
Quick Info

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

RasSetCredentials

[New - Windows NT]

The RasSetCredentials function sets the user credentials associated with a specified RAS phone-book entry.

DWORD RasSetCredentials(

LPTSTR lpszPhonebook,
// pointer to the full path and filename of a phone-book file
LPTSTR lpszEntry,
// pointer to the name of a phone-book entry
LPRASCREDENTIALS lpCredentials
// pointer to structure that specifies the credentials
);

Parameters

lpszPhonebook

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.

lpszEntry

Pointer to a null-terminated string that contains the name of a phone-book entry.

lpCredentials

Pointer to a RASCREDENTIALS structure that specifies the user credentials to set for the specified phone-book entry. Before calling RasSetCredentials, set the dwSize member of the structure to sizeof(RASCREDENTIALS). Set the dwMask member to indicate the credential information to be set.

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
Meaning
ERROR_CANNOT_OPEN_PHONEBOOK
The specified phone book cannot be found.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY
The specified entry does not exist in the phone book.
ERROR_INVALID_PARAMETER
The lpCredentials parameter was NULL.
ERROR_INVALID_SIZE
The dwSize member of the RASCREDENTIALS structure is an unrecognized value.

Remarks

The RasSetCredentials function sets the user credentials associated with a specified RAS phone-book entry. The credentials stored with a phone-book entry are the credentials of the last user to successfully connect using the specified phone-book entry, or the credentials subsequently specified in a call to the RasSetCredentials or RasSetEntryDialParams function for the phone-book entry.

The RasSetCredentials function is the preferred way of securely storing credentials with a phone-book entry. RasSetCredentials supersedes the RasSetEntryDialParams function, which may not be supported in future releases of Windows NT.

See Also

RASCREDENTIALS
, RasGetCredentials, 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