SspiPromptForCredentialsA, fonction (sspi.h)

Article
08/26/2023

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

Syntaxe

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

Paramètres

[in] pszTargetName

Nom de la cible à utiliser.

[in] pUiInfo

Pointeur vers une structure de CREDUI_INFO qui contient des informations permettant de 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 a la valeur 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 passer 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 zone Enregistrer case activée est sélectionnée dans la boîte de dialogue affichée par cette fonction. Lors de la sortie, la valeur de ce paramètre spécifie si la zone Enregistrer case activée a été sélectionné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 zone Enregistrer case activée.

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 a été SSPIPFC_SAVE_CRED_BY_CALLER.
SSPIPFC_NO_CHECKBOX 0x00000002	La valeur indique que les fournisseurs d’informations d’identification de mot de passe et de carte intelligents n’affichent pas la case à cocher « Mémoriser mes informations d’identification » pour l’utilisateur. La fonction SspiPromptForCredentials transmet cette valeur d’indicateur, SSPIPFC_NO_CHECKBOX, dans le paramètre pvInAuthBuffer de la 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 a été SSPIPFC_SAVE_CRED_BY_CALLER.

SSPIPFC_NO_CHECKBOX
0x00000002

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

Valeur retournée

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

Notes

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. La combinaison 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.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 7 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 R2 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	sspi.h
Bibliothèque	Credui.lib
DLL	Credui.dll

Partager via