Função SHFormatDrive (shlobj_core.h)

[SHFormatDrive está disponível para uso nos sistemas operacionais especificados na seção Requisitos. Ele pode estar alterado ou indisponível em versões subsequentes.]

Abre a caixa de diálogo Formato do Shell.

Sintaxe

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

Parâmetros

[in] hwnd

Digite: HWND

O identificador da janela pai da caixa de diálogo. A caixa de diálogo Formatar deve ter uma janela pai; portanto, esse parâmetro não pode ser NULL.

drive

Tipo: UINT

A unidade a ser formatada. O valor desse parâmetro representa uma unidade de letra começando em 0 para a unidade A:. Por exemplo, um valor de 2 significa a unidade C:.

fmtID

Tipo: UINT

A ID do formato físico. Somente o sinalizador a seguir está definido no momento.

SHFMT_ID_DEFAULT (0xFFFF)

A ID de formato padrão.

options

Tipo: UINT

Esse valor deve ser 0 ou um dos valores a seguir que alteram as opções de formato padrão na caixa de diálogo. Esse valor é considerado um campo de bits e deve ser tratado adequadamente.

SHFMT_OPT_FULL (0x0001)

0x001. Se esse sinalizador estiver definido, a opção Formato Rápido será selecionada.

Essa função é incluída em Shlobj.h somente no Windows XP com SP1 e posterior.

Windows XP: Antes do Windows XP com SP1, essa função era acessível por meio do Shell32.lib.

SHFMT_OPT_SYSONLY (0x0002)

0x002. Seleciona a opção Criar um disco de inicialização do MS-DOS , criando um disco de inicialização do sistema.

Retornar valor

Tipo: DWORD

Retorna a ID de formato do último formato bem-sucedido ou um dos valores a seguir. O LOWORD desse valor pode ser passado em chamadas subsequentes como o parâmetro fmtID para repetir o último formato.

Código de retorno	Descrição
SHFMT_ERROR	Ocorreu um erro durante o último formato. Isso não indica que a unidade é informata.
SHFMT_CANCEL	O último formato foi cancelado.
SHFMT_NOFORMAT	A unidade não pode ser formatada.

Comentários

O formato é controlado pela interface da caixa de diálogo. Ou seja, o usuário deve clicar no botão OK para realmente iniciar o formato — o formato não pode ser iniciado programaticamente.

Exemplos

Essa chamada para SHFormatDrive abre a caixa de diálogo Formato do Shell para um disco na unidade A, com as opções de formatação padrão selecionadas.

SHFormatDrive(hMainWnd, 0, SHFMT_ID_DEFAULT, 0);

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	shlobj_core.h (inclua Shlobj.h)
Biblioteca	Shell32.lib
DLL	Shell32.dll (versão 5.0 ou posterior)