RasGetEapUserIdentityA-Funktion (ras.h)

Artikel
08/25/2023

Die RasGetEapUserIdentity-Funktion ruft Identitätsinformationen für den aktuellen Benutzer ab. Verwenden Sie diese Informationen, um RasDial mit einem Telefonbucheintrag aufzurufen, der das Extensible Authentication Protocol (EAP) erfordert.

Syntax

DWORD RasGetEapUserIdentityA(
  [in]  LPCSTR                pszPhonebook,
  [in]  LPCSTR                pszEntry,
  [in]  DWORD                 dwFlags,
  [in]  HWND                  hwnd,
  [out] LPRASEAPUSERIDENTITYA *ppRasEapUserIdentity
);

Parameter

[in] pszPhonebook

Zeiger auf eine NULL-beendete Zeichenfolge, die den vollständigen Pfad der PBK-Datei (Telefonbuchdatei) angibt. Wenn dieser Parameter NULL ist, verwendet die Funktion das Systemtelefonbuch.

[in] pszEntry

Zeiger auf eine NULL-Zeichenfolge, die einen vorhandenen Eintragsnamen angibt.

[in] dwFlags

Gibt mindestens null der folgenden Flags an, die den Authentifizierungsprozess qualifizieren.

Flag	Bedeutung
RASEAPF_NonInteractive	Gibt an, dass das Authentifizierungsprotokoll keine grafische Benutzeroberfläche anzeigen soll. Wenn dieses Flag nicht vorhanden ist, ist es in Ordnung, dass das Protokoll eine Benutzeroberfläche anzeigt.
RASEAPF_Logon	Gibt an, dass die Benutzerdaten von WinLogon abgerufen werden.
RASEAPF_Preview	Gibt an, dass der Benutzer vor dem Wählen zur Eingabe von Identitätsinformationen aufgefordert werden soll.

[in] hwnd

Handle mit dem übergeordneten Fenster für das Dialogfeld der Benutzeroberfläche. Wenn der fInvokeUI-ParameterFALSE ist, sollte hwndNULL sein.

[out] ppRasEapUserIdentity

Zeiger auf einen Zeiger, der bei erfolgreicher Rückgabe die Adresse der RASEAPUSERIDENTITY-Struktur empfängt , die EAP-Benutzeridentitätsinformationen enthält. RasGetEapUserIdentity weist den Speicherpuffer für die RASEAPUSERIDENTITY-Struktur zu. Geben Sie diesen Arbeitsspeicher frei, indem Sie RasFreeEapUserIdentity aufrufen.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert ERROR_SUCCESS.

Wenn die Funktion fehlschlägt, ist der Rückgabewert einer der folgenden Fehlercodes oder ein Wert aus Routing- und RAS-Fehlercodes oder Winerror.h.

Wert	Bedeutung
E_INVALID_ARG	Der pcbEapUserIdentity-Parameter ist NULL.
ERROR_INTERACTIVE_MODE	Die Funktion wurde mit dem RASEAPF_NonInteractive-Flag aufgerufen. Das Authentifizierungsprotokoll muss jedoch eine Benutzeroberfläche anzeigen, um die erforderlichen Identitätsinformationen vom Benutzer abzurufen.
ERROR_INVALID_FUNCTION_FOR_ENTRY	Entweder ist die Authentifizierungsmethode für diesen Telefonbucheintrag nicht EAP, oder die Authentifizierungsmethode ist EAP, aber das Protokoll verwendet das Standardmäßige Windows NT/Windows 2000-Anmeldeinformationsdialogfeld, um Informationen zur Benutzeridentität abzurufen. In beiden Fällen muss der Aufrufer keine EAP-Identitätsinformationen an RasDial übergeben.
ERROR_RASMAN_CANNOT_INITIALIZE	Der RAS-Dienst konnte nicht ordnungsgemäß initialisiert werden.
Andere	Verwenden Sie FormatMessage , um die Systemfehlermeldung abzurufen, die dem zurückgegebenen Fehlercode entspricht.

Hinweise

RasGetEapUserIdentity ruft die RAS-Funktion RasGetEapUserData und die EAP-Funktion RasEapGetIdentity auf. RasEapGetIdentity wird vom Authentifizierungsprotokoll implementiert.

Wenn die Funktion erfolgreich ist, d. h. der Rückgabewert NO_ERROR ist, sollte der Aufrufer die EAP-Identitätsinformationen aus der RASEAPUSERIDENTITY-Struktur kopieren, auf die der ppRasEapUserIdentity-Parameter verweist, in die RASDIALPARAMS - und RASDIALEXTENSIONS-Strukturen , die im Aufruf von RasDial verwendet werden.

Wenn die zu entwickelnde Remotezugriffsanwendung über eine grafische Benutzeroberfläche verfügt, sollte der Aufrufer von RasGetEapUserIdentity das RASEAPF_NonInteractive Flag nicht angeben. Wenn die Anwendung über eine Befehlszeilenbenutzeroberfläche verfügt, kann der Aufrufer das RASEAPF_NonInteractive-Flag angeben, um zu verhindern, dass das Authentifizierungsprotokoll eine grafische Benutzeroberfläche anzeigt.

Hinweis

Der ras.h-Header definiert RasGetEapUserIdentity als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	ras.h
Bibliothek	Rasapi32.lib
DLL	Rasapi32.dll