RasSetEapUserDataA function (ras.h)

Article
02/09/2023

Use the RasSetEapUserData function to store user-specific Extensible Authentication Protocol (EAP) information for the specified phone-book entry in the registry.

Syntax

DWORD RasSetEapUserDataA(
  [in] HANDLE hToken,
  [in] LPCSTR pszPhonebook,
  [in] LPCSTR pszEntry,
  [in] BYTE   *pbEapData,
  [in] DWORD  dwSizeofEapData
);

Parameters

[in] hToken

Handle to a primary or impersonation access token that represents the user for which to store data. This parameter can be NULL if the function is called from a process already running in the user's context.

[in] pszPhonebook

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.

[in] pszEntry

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

[in] pbEapData

Pointer to the data to store for the user.

[in] dwSizeofEapData

Specifies the size of the data pointed to by the pbEapData parameter.

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.

Value	Meaning
E_INVALIDARG	The dwSizeofEapData parameter is zero, or the pbEapData parameter is NULL.
ERROR_CANNOT_OPEN_PHONEBOOK	RasSetEapUserData was unable to open the specified phone-book file.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	RasSetEapUserData 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.

Remarks

Note

The ras.h header defines RasSetEapUserData as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	ras.h
Library	Rasapi32.lib
DLL	Rasapi32.dll