The RasSetCredentials function sets the user credentials associated with a specified RAS phone-book entry.
DWORD RasSetCredentials(
LPCTSTR lpszPhonebook, // pointer to the full path and filename
// of a phone-book file
LPCTSTR lpszEntry, // pointer to the name of a phone-book
// entry
LPRASCREDENTIALS lpCredentials,
// pointer to structure that specifies the
// credentials
BOOL fClearCredentials // if true, credentials are cleared
// if false, credentials are set
);
sizeof(RASCREDENTIALS)
. Set the dwMask member to indicate the credential information to be set. 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. |
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.
Windows NT: Requires version 4.0 or later.
Windows: Unsupported.
Windows CE: Unsupported.
Header: Declared in ras.h.
Import Library: Use rasapi32.lib.
Unicode: Implemented as Unicode and ANSI versions on Windows NT.
Remote Access Service Overview, RAS Server Administration Functions, RASCREDENTIALS, RasGetCredentials, RasSetEntryDialParams