RasGetCredentials

The RasGetCredentials function retrieves the user credentials associated with a specified RAS phone-book entry. 

DWORD RasGetCredentials(
  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
                                    // receives 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 receives the user credentials associated with the specified phone-book entry. Before calling RasGetCredentials, set the dwSize member of the structure to sizeof(RASCREDENTIALS), and set the dwMask member to indicate the credential information to retrieve. When the function returns, dwMask indicates the members that were successfully retrieved.

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 RasGetCredentials function retrieves 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 function for the phone-book entry.

The RasGetCredentials function retrieves the user credentials that are stored securely for the specified phone-book entry. This function is the preferred way of securely retrieving the credentials associated with a RAS phone book entry. RasGetCredentials supersedes the RasGetEntryDialParams function, which may not be supported in future releases of Windows NT.

QuickInfo

  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.

See Also

Remote Access Service Overview, RAS Server Administration Functions, RASCREDENTIALS, RasGetEntryDialParams, RasSetCredentials