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

Affiche un message dans la boîte de dialogue de progression.

Syntaxe

HRESULT SetLine(
       DWORD   dwLineNum,
  [in] PCWSTR  pwzString,
       BOOL    fCompactPath,
       LPCVOID pvResevered
);

Paramètres

dwLineNum

Type : DWORD

Numéro de ligne sur lequel le texte doit être affiché. Il existe actuellement trois lignes : 1, 2 et 3. Si l’indicateur PROGDLG_AUTOTIME a été inclus dans le paramètre dwFlags lorsque IProgressDialog ::StartProgressDialog a été appelé, seules les lignes 1 et 2 peuvent être utilisées. L’heure estimée sera affichée à la ligne 3.

[in] pwzString

Type : PCWSTR

Chaîne Unicode terminée par null qui contient le texte.

fCompactPath

Type : BOOL

TRUE pour que les chaînes de chemin soient compactées si elles sont trop grandes pour tenir sur une ligne. Les chemins d’accès sont compactés avec PathCompactPath.

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

Cette fonction est généralement utilisée pour afficher un message tel que « L’élément XXX est en cours de traitement ». En règle générale, les messages sont affichés aux lignes 1 et 2, la ligne 3 étant réservée pour l’heure estimée.

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