Freigeben über


SspiPromptForCredentialsA-Funktion (sspi.h)

Ermöglicht einer SSPI-Anwendung (Security Support Provider Interface) die Eingabe von Anmeldeinformationen durch einen Benutzer.

Syntax

unsigned long SEC_ENTRY SspiPromptForCredentialsA(
  [in]                PCSTR                           pszTargetName,
  [in]                PCREDUI_INFOA                   pUiInfo,
  [in]                unsigned long                   dwAuthError,
  [in]                PCSTR                           pszPackage,
  [in]                PSEC_WINNT_AUTH_IDENTITY_OPAQUE pInputAuthIdentity,
  [out]               PSEC_WINNT_AUTH_IDENTITY_OPAQUE *ppAuthIdentity,
  [in, out, optional] int                             *pfSave,
  [in]                unsigned long                   dwFlags
);

Parameter

[in] pszTargetName

Der Name des zu verwendenden Ziels.

[in] pUiInfo

Ein Zeiger auf eine CREDUI_INFO Struktur, die Informationen zum Anpassen der Darstellung des angezeigten Dialogfelds enthält.

Wenn das hwndParent Element der CREDUI_INFO Struktur nicht NULL-ist, zeigt diese Funktion ein modales Dialogfeld an, das auf dem übergeordneten Fenster zentriert ist.

Wenn das hwndParent Element der CREDUI_INFO Struktur NULL-ist, zeigt die Funktion ein Dialogfeld an, das auf dem Bildschirm zentriert ist.

Diese Funktion ignoriert die hbmBanner Member der CREDUI_INFO Struktur.

[in] dwAuthError

Ein In Winerror.h definierter Windows-Fehlercode, der im Dialogfeld angezeigt wird. Wenn zuvor gesammelte Anmeldeinformationen ungültig waren, verwendet der Aufrufer diesen Parameter, um die Fehlermeldung von der API zu übergeben, die die Anmeldeinformationen (z. B. Winlogon) an diese Funktion gesammelt hat. Die entsprechende Fehlermeldung wird formatiert und im Dialogfeld angezeigt. Legen Sie den Wert dieses Parameters auf Null fest, um keine Fehlermeldung anzuzeigen.

[in] pszPackage

Der Name des zu verwendenden Sicherheitspakets.

[in] pInputAuthIdentity

Eine Identitätsstruktur, die zum Auffüllen von Anmeldeinformationsfeldern im Dialogfeld verwendet wird. Um die Anmeldeinformationsfelder leer zu lassen, legen Sie den Wert dieses Parameters auf NULL-fest.

[out] ppAuthIdentity

Eine Identitätsstruktur, die die von dieser Funktion erfassten Anmeldeinformationen darstellt.

Wenn Sie diese Struktur verwendet haben, geben Sie sie frei, indem Sie die SspiFreeAuthIdentity-Funktion aufrufen.

[in, out, optional] pfSave

Ein Zeiger auf einen booleschen Wert, der bei Eingaben angibt, ob das Kontrollkästchen speichern im dialogfeld aktiviert ist, das diese Funktion anzeigt. Bei der Ausgabe gibt der Wert dieses Parameters an, ob das Kontrollkästchen Speichern aktiviert wurde, wenn der Benutzer im Dialogfeld auf die Schaltfläche Absenden geklickt hat. Legen Sie diesen Parameter auf NULL- fest, um das Kontrollkästchen Speichern zu ignorieren.

Dieser Parameter wird ignoriert, wenn das CREDUIWIN_CHECKBOX Flag nicht im dwFlags Parameter festgelegt ist.

[in] dwFlags

Flags, die das Verhalten dieser Funktion bestimmen. Das folgende Flag ist derzeit definiert.

Wert Bedeutung
SSPIPFC_CREDPROV_DO_NOT_SAVE
0x00000001
Der Wert des pfSave-Parameters wird ignoriert, und die von dieser Funktion gesammelten Anmeldeinformationen werden nicht gespeichert.

Windows 7 und Windows Server 2008 R2: Der Wert des parameters pfSave wird ignoriert, und die von dieser Funktion gesammelten Anmeldeinformationen werden nicht gespeichert. Nur der Name dieses möglichen Werts wurde SSPIPFC_SAVE_CRED_BY_CALLER.

SSPIPFC_NO_CHECKBOX
0x00000002
Der Wert gibt an, dass dem Benutzer das Kontrollkästchen "Meine Anmeldeinformationen speichern" nicht angezeigt wird. Die SspiPromptForCredentials--Funktion übergibt diesen Flagwert, SSPIPFC_NO_CHECKBOX, im pvInAuthBuffer Parameter von CredUIPromptForWindowsCredentials-Funktion.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird SEC_E_OKzurückgegeben.

Wenn die Funktion fehlschlägt, wird ein Fehlercode ungleich Null zurückgegeben.

Bemerkungen

Anmerkung

Der Header "sspi.h" definiert SspiPromptForCredentials 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 Code, der nicht codierungsneutral ist, 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
mindestens unterstützte Client- Windows 7 [nur Desktop-Apps]
mindestens unterstützte Server- Windows Server 2008 R2 [nur Desktop-Apps]
Zielplattform- Fenster
Header- sspi.h
Library Credui.lib
DLL- Credui.dll