Share via


RasGetEapUserData (Compact 2013)

3/26/2014

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 Compact.
  • 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, RasGetEapUserData will return ERROR_BUFFER_TOO_SMALL, and the pdwSizeofEapData parameter will contain 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.

Value

Description

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

Header

ras.h

Library

coredll.lib

See Also

Reference

RAS Functions

Other Resources

FormatMessage