Partager via

Fonction SHFormatDrive (shlobj_core.h)

  • Article

[SHFormatDrive peut être utilisé dans les systèmes d’exploitation spécifiés dans la section Configuration requise. Il peut être modifié ou indisponible dans les versions suivantes.]

Ouvre la boîte de dialogue Format de l’interpréteur de commandes.

Syntaxe

DWORD SHFormatDrive(
  [in] HWND hwnd,
       UINT drive,
       UINT fmtID,
       UINT options
);

Paramètres

[in] hwnd

Type : HWND

Handle de la fenêtre parente de la boîte de dialogue. La boîte de dialogue Format doit avoir une fenêtre parente ; Par conséquent, ce paramètre ne peut pas être NULL.

drive

Type : UINT

Lecteur à mettre en forme. La valeur de ce paramètre représente un lecteur de lettres commençant à 0 pour le lecteur A :. Par exemple, la valeur 2 correspond au lecteur C :.

fmtID

Type : UINT

ID du format physique. Seul l’indicateur suivant est actuellement défini.

SHFMT_ID_DEFAULT (0xFFFF)

ID de format par défaut.

options

Type : UINT

Cette valeur doit être 0 ou l’une des valeurs suivantes qui modifient les options de format par défaut dans la boîte de dialogue. Cette valeur est considérée comme un champ de bits et doit être traitée en conséquence.

SHFMT_OPT_FULL (0x0001)

0x001. Si cet indicateur est défini, l’option Format rapide est sélectionnée.

Cette fonction est incluse dans Shlobj.h uniquement dans Windows XP avec SP1 et versions ultérieures.

Windows XP : Avant Windows XP avec SP1, cette fonction était accessible via Shell32.lib.

SHFMT_OPT_SYSONLY (0x0002)

0x002. Sélectionne l’option Créer un disque de démarrage MS-DOS , ce qui crée un disque de démarrage système.

Valeur retournée

Type : DWORD

Retourne l’ID de format du dernier format réussi ou l’une des valeurs suivantes. Le LOWORD de cette valeur peut être transmis aux appels suivants en tant que paramètre fmtID pour répéter le dernier format.

Code de retour Description
SHFMT_ERROR
 Une erreur s’est produite lors du dernier format. Cela n’indique pas que le lecteur n’est pas formatable.
SHFMT_CANCEL
 Le dernier format a été annulé.
SHFMT_NOFORMAT
 Impossible de mettre en forme le lecteur.

Remarques

Le format est contrôlé par l’interface de la boîte de dialogue. Autrement dit, l’utilisateur doit cliquer sur le bouton OK pour commencer réellement le format. Le format ne peut pas être démarré par programmation.

Exemples

Cet appel à SHFormatDrive affiche la boîte de dialogue Format de l’interpréteur de commandes pour un disque du lecteur A, avec les options de mise en forme par défaut sélectionnées.

SHFormatDrive(hMainWnd, 0, SHFMT_ID_DEFAULT, 0);

Configuration requise

Condition requise Valeur
Client minimal pris en charge 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 (inclure Shlobj.h)
Bibliothèque Shell32.lib
DLL Shell32.dll (version 5.0 ou ultérieure)