SspiPromptForCredentialsW-Funktion (sspi.h)

Artikel
08/26/2023

Ermöglicht einer SSPI-Anwendung (Security Support Provider Interface ), einen Benutzer zur Eingabe von Anmeldeinformationen aufzufordern.

Syntax

unsigned long SEC_ENTRY SspiPromptForCredentialsW(
  [in]                PCWSTR                          pszTargetName,
  [in]                PCREDUI_INFOW                   pUiInfo,
  [in]                unsigned long                   dwAuthError,
  [in]                PCWSTR                          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 Dialogfelds enthält, das von dieser Funktion angezeigt wird.

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-StrukturNULL ist, zeigt die Funktion ein Dialogfeld zentriert auf dem Bildschirm an.

Diese Funktion ignoriert das hbmBanner-Element 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, übergibt der Aufrufer diesen Parameter, um die Fehlermeldung von der API zu übergeben, die die Anmeldeinformationen (z. B. Winlogon) gesammelt hat, an diese Funktion. 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 Anmeldeinformationen im Dialogfeld verwendet wird. Damit die Anmeldeinformationsfelder leer bleiben, legen Sie den Wert dieses Parameters auf NULL fest.

[out] ppAuthIdentity

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

Wenn Sie die Verwendung dieser Struktur abgeschlossen haben, geben Sie sie frei, indem Sie die Funktion SspiFreeAuthIdentity aufrufen.

[in, out, optional] pfSave

Ein Zeiger auf einen booleschen Wert, der bei der Eingabe angibt, ob das Kontrollkästchen Speichern im Von dieser Funktion angezeigten Dialogfeld aktiviert ist. 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 Übermitteln 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 pfSave-Parameters 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 weist darauf hin, dass kennwort- und intelligente Karte Anmeldeinformationenanbieter das Kontrollkästchen "Meine Anmeldeinformationen speichern" für den Benutzer nicht anzeigen. Die SspiPromptForCredentials-Funktion übergibt diesen Flagwert SSPIPFC_NO_CHECKBOX im parameter pvInAuthBuffer der CredUIPromptForWindowsCredentials-Funktion .

Rückgabewert

Wenn die Funktion erfolgreich ist, gibt sie SEC_E_OK zurück.

Wenn die Funktion fehlschlägt, gibt sie einen fehlerfreien Fehlercode zurück.

Hinweise

Hinweis

Der sspi.h-Header 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 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


Unterstützte Mindestversion (Client)	Windows 7 [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 R2 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	sspi.h
Bibliothek	Credui.lib
DLL	Credui.dll

Freigeben über