Platform SDK: RAS/Routing and RAS

RasGetEapUserData

Use the RasGetEapUserData function to retrieve user-specific Extensible Authentication Protocol (EAP) information for the specified phone-book entry.

DWORD RasGetEapUserData (
  HANDLE hToken,             // access token for user 
  LPCTSTR pszPhonebook,      // path to phone book to use 
  LPCTSTR pszEntry,          // name of entry in phone book 
  BYTE *pbEapData,           // retrieved data for the user 
  DWORD *pdwSizeofEapData    // size of retrieved data 
);

Parameters

hToken
Handle to a primary or impersonation access token that represents the user for which to retrieve data. This parameter can be NULL if the function is called from a process already running in the user's context.
pszPhonebook
Pointer to a null-terminated string containing the full path of the phone-book (PBK) file. If this parameter is NULL, the function will use the system phone book.
pszEntry
Pointer to a null-terminated string containing an existing entry name.
pbEapData
Pointer to a buffer to receive the retrieved EAP data for the user. The caller should allocate the memory for this buffer. If the buffer is not large enough, RasGetEapUserData will return ERROR_BUFFER_TOO_SMALL, and the pdwSizeofEapData parameter will contain the required size.
pdwSizeofEapData
Pointer to a DWORD variable that contains the size of the buffer pointed to by the pbEapData parameter.

Return Values

If the function succeeds, the return value is ERROR_SUCCESS.

If the function fails, the retun value is one of the following error codes.

Value Meaning
E_INVALIDARG The pdwSizeofEapData parameter is NULL.
ERROR_BUFFER_TOO_SMALL The buffer pointed to by pbEapData is too small to receive the data. The pdwSizeofEapData contains the required size.
ERROR_CANNOT_OPEN_PHONEBOOK RasGetEapUserData was unable to open the specified phone-book file.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY RasGetEapUserData was unable to find the specified entry in the phone book.
Other Use FormatMessage to retrieve the system error message that corresponds to the error code returned.

Requirements

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

See Also

Remote Access Service (RAS) Overview, Remote Access Service Functions, RasSetEapUserData, RASEAPINFO