RasGetEapUserData function

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

Syntax


DWORD RasGetEapUserData(
  _In_    HANDLE  hToken,
  _In_    LPCTSTR pszPhonebook,
  _In_    LPCTSTR pszEntry,
  _Out_   BYTE    *pbEapData,
  _Inout_ DWORD   *pdwSizeofEapData
);

Parameters

hToken [in]

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 [in]

Pointer to a null-terminated string that specifies the full path of the phone-book (PBK) file. If this parameter is NULL, the function uses the system phone book.

pszEntry [in]

Pointer to a null-terminated string that specifies an existing entry name.

pbEapData [out]

Pointer to a buffer that receives the retrieved EAP data for the user. The caller should allocate the memory for this buffer. If the buffer is not large enough, RasGetEapUserData returns ERROR_BUFFER_TOO_SMALL, and the pdwSizeofEapData parameter contains the required size.

pdwSizeofEapData [in, out]

Pointer to a DWORD variable that, on input, specifies the size of the buffer pointed to by the pbEapData parameter.

If the buffer specified by the pbEapData parameter is not large enough, pdwSizeofEapData receives, on output, the required size.

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.

ValueMeaning
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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Ras.h

Library

Rasapi32.lib

DLL

Rasapi32.dll

Unicode and ANSI names

RasGetEapUserDataW (Unicode) and RasGetEapUserDataA (ANSI)

See also

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

 

 

Show: