Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function retrieves user-specific Extensible Authentication Protocol (EAP) information for the specified phone-book entry.

Syntax 

DWORD RasGetEapUserData(
  HANDLE 
hToken,
  LPCTSTR 
pszPhonebook, 
  LPCTSTR 
pszEntry, 
  PBYTE 
pbEapData, 
  PDWORD 
pdwSizeofEapData
);

Parameters

hToken

[in] This parameter should always be NULL for Windows Embedded CE.

pszPhonebook

[in] This parameter is ignored and should be set to NULL. Dial-up networking stores phone-book entries in the registry rather than in a phone-book file.

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, RasGetEapUserDatawill return ERROR_BUFFER_TOO_SMALL, and the pdwSizeofEapDataparameter will contain the required size.

pdwSizeofEapData

[in/out]Pointer to a DWORDvariable that, on input, specifies the size of the buffer pointed to by the pbEapDataparameter.

If the buffer specified by the pbEapDataparameter is not large enough, pdwSizeofEapDatareceives, 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.

Value Description

E_INVALIDARG

The pdwSizeofEapDataparameter is NULL.

ERROR_BUFFER_TOO_SMALL

The buffer pointed to by pbEapDatais too small to receive the data. The pdwSizeofEapDatacontains the required size.

ERROR_CANNOT_OPEN_PHONEBOOK

RasGetEapUserDatawas unable to open the specified phone-book file.

ERROR_CANNOT_FIND_PHONEBOOK_ENTRY

RasGetEapUserDatawas unable to find the specified entry in the phone book.

Other

Use FormatMessageto retrieve the system error message that corresponds to the error code returned.

Requirements

Header ras.h
Library coredll.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also