Méthode IProgressDialog ::SetCancelMsg (shlobj_core.h)

  • Article

Définit un message à afficher si l’utilisateur annule l’opération.

Syntaxe

HRESULT SetCancelMsg(
  [in] PCWSTR  pwzCancelMsg,
       LPCVOID pvResevered
);

Paramètres

[in] pwzCancelMsg

Type : PCWSTR

Pointeur vers une chaîne Unicode terminée par null qui contient le message à afficher.

pvResevered

Type : LPCVOID

Réservé. Défini sur NULL.

Valeur retournée

Type : HRESULT

Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Même si l’utilisateur clique sur Annuler, l’application ne peut pas appeler immédiatement IProgressDialog ::StopProgressDialog pour fermer la boîte de dialogue. L’application doit attendre la prochaine fois qu’elle appelle IProgressDialog ::HasUserCancelled pour découvrir que l’utilisateur a annulé l’opération. Étant donné que ce délai peut être important, la boîte de dialogue de progression fournit à l’utilisateur un retour immédiat en supprimant les lignes de texte 1 et 2 et en affichant le message d’annulation à la ligne 3. Le message est destiné à informer l’utilisateur que le délai est normal et que la boîte de dialogue de progression sera fermée sous peu. Il est généralement défini sur quelque chose comme « Veuillez patienter pendant ... ».

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 2000 Professionnel, Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2003 [applications de bureau uniquement]
Plateforme cible Windows
En-tête shlobj_core.h
DLL Shell32.dll (version 5.0 ou ultérieure)

Voir aussi

IProgressDialog