SspiPromptForCredentialsW, fonction (sspi.h)

Article
11/20/2024

Permet à une application Security Support Provider Interface (SSPI) d’inviter un utilisateur à entrer des informations d’identification.

Syntaxe

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
);

Paramètres

[in] pszTargetName

Nom de la cible à utiliser.

[in] pUiInfo

Pointeur vers une structure CREDUI_INFO qui contient des informations pour personnaliser l’apparence de la boîte de dialogue affichée par cette fonction.

Si le membre hwndParent de la structure CREDUI_INFO n’est pas NULL, cette fonction affiche une boîte de dialogue modale centrée sur la fenêtre parente.

Si le membre hwndParent de la structure CREDUI_INFO est NULL, la fonction affiche une boîte de dialogue centrée sur l’écran.

Cette fonction ignore le membre hbmBanner de la structure CREDUI_INFO.

[in] dwAuthError

Code d’erreur Windows, défini dans Winerror.h, qui s’affiche dans la boîte de dialogue. Si les informations d’identification précédemment collectées n’étaient pas valides, l’appelant utilise ce paramètre pour transmettre le message d’erreur de l’API qui a collecté les informations d’identification (par exemple, Winlogon) à cette fonction. Le message d’erreur correspondant est mis en forme et affiché dans la boîte de dialogue. Définissez la valeur de ce paramètre sur zéro pour afficher aucun message d’erreur.

[in] pszPackage

Nom du package de sécurité à utiliser.

[in] pInputAuthIdentity

Structure d’identité utilisée pour remplir les champs d’informations d’identification dans la boîte de dialogue. Pour laisser les champs d’informations d’identification vides, définissez la valeur de ce paramètre sur NULL.

[out] ppAuthIdentity

Structure d’identité qui représente les informations d’identification collectées par cette fonction.

Lorsque vous avez terminé d’utiliser cette structure, libérez-la en appelant la fonction SspiFreeAuthIdentity.

[in, out, optional] pfSave

Pointeur vers une valeur booléenne qui, lors de l’entrée, spécifie si la case Enregistrer est cochée dans la boîte de dialogue affichée par cette fonction. En sortie, la valeur de ce paramètre spécifie si la case Enregistrer a été cochée lorsque l’utilisateur a cliqué sur le bouton Envoyer dans la boîte de dialogue. Définissez ce paramètre sur NULL pour ignorer la case Enregistrer.

Ce paramètre est ignoré si l’indicateur CREDUIWIN_CHECKBOX n’est pas défini dans le paramètre dwFlags.

[in] dwFlags

Indicateurs qui déterminent le comportement de cette fonction. L’indicateur suivant est actuellement défini.

Valeur	Signification
SSPIPFC_CREDPROV_DO_NOT_SAVE 0x00000001	La valeur du paramètre pfSave est ignorée et les informations d’identification collectées par cette fonction ne sont pas enregistrées. Windows 7 et Windows Server 2008 R2 : La valeur du paramètre pfSave est ignorée et les informations d’identification collectées par cette fonction ne sont pas enregistrées. Seul le nom de cette valeur possible était SSPIPFC_SAVE_CRED_BY_CALLER.
SSPIPFC_NO_CHECKBOX 0x00000002	La valeur signifie que les fournisseurs d’informations d’identification de mot de passe et de carte à puce n’affichent pas la case à cocher « Mémoriser mes informations d’identification » à l’utilisateur. La fonction SspiPromptForCredentials transmet cette valeur d’indicateur, SSPIPFC_NO_CHECKBOX, dans le paramètre pvInAuthBuffer de fonction CredUIPromptForWindowsCredentials.

Valeur

Signification

SSPIPFC_CREDPROV_DO_NOT_SAVE
0x00000001

La valeur du paramètre pfSave est ignorée et les informations d’identification collectées par cette fonction ne sont pas enregistrées.

Windows 7 et Windows Server 2008 R2 : La valeur du paramètre pfSave est ignorée et les informations d’identification collectées par cette fonction ne sont pas enregistrées. Seul le nom de cette valeur possible était SSPIPFC_SAVE_CRED_BY_CALLER.

SSPIPFC_NO_CHECKBOX
0x00000002

La valeur signifie que les fournisseurs d’informations d’identification de mot de passe et de carte à puce n’affichent pas la case à cocher « Mémoriser mes informations d’identification » à l’utilisateur. La fonction SspiPromptForCredentials transmet cette valeur d’indicateur, SSPIPFC_NO_CHECKBOX, dans le paramètre pvInAuthBuffer de fonction CredUIPromptForWindowsCredentials.

Valeur de retour

Si la fonction réussit, elle retourne SEC_E_OK.

Si la fonction échoue, elle retourne un code d’erreur différent de zéro.

Remarques

Note

L’en-tête sspi.h définit SspiPromptForCredentials en tant qu’alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows 7 [applications de bureau uniquement]
serveur minimum pris en charge	Windows Server 2008 R2 [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	sspi.h
bibliothèque	Credui.lib
DLL	Credui.dll

Partager via