Função SetVolumeLabelA (winbase.h)
Define o rótulo de um volume do sistema de arquivos.
Sintaxe
BOOL SetVolumeLabelA(
[in, optional] LPCSTR lpRootPathName,
[in, optional] LPCSTR lpVolumeName
);
Parâmetros
[in, optional] lpRootPathName
Um ponteiro para uma cadeia de caracteres que contém a letra da unidade do volume (por exemplo, X:) ou o caminho de uma pasta montada associada ao volume (por exemplo, Y:\MountX). A cadeia de caracteres deve terminar com uma barra invertida à direita (''). Se esse parâmetro for NULL, a raiz do diretório atual será usada.
[in, optional] lpVolumeName
Um ponteiro para uma cadeia de caracteres que contém o novo rótulo para o volume. Se esse parâmetro for NULL, a função excluirá qualquer rótulo existente do volume especificado e não atribuirá um novo rótulo.
Valor retornado
Se a função for bem-sucedida, o valor retornado será diferente de zero.
Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.
Comentários
O comprimento máximo do rótulo do volume é de 32 caracteres.
Sistemas de arquivos FAT: O comprimento máximo do rótulo do volume é de 11 caracteres.
Um rótulo é um nome amigável que um usuário atribui a um volume para facilitar o reconhecimento. Um volume pode ter um rótulo, uma letra de unidade, ambos ou nenhum deles. Para obter mais informações, consulte Nomeando um volume.
No Windows 8 e Windows Server 2012, essa função é compatível com as tecnologias a seguir.
| Tecnologia | Com suporte |
|---|---|
| Protocolo SMB (SMB) 3.0 | No |
| TFO (Failover transparente) do SMB 3.0 | No |
| SMB 3.0 com compartilhamentos de arquivos de expansão (SO) | No |
| Sistema de arquivos de Volume Compartilhado Clusterizado (CsvFS) | Sim |
| ReFS (Sistema de Arquivos Resiliente) | Sim |
O SMB não dá suporte a funções de gerenciamento de volume.
Observação
O cabeçalho winbase.h define SetVolumeLabel como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Windows XP [aplicativos da área de trabalho | aplicativos UWP] |
| Servidor mínimo com suporte | Windows Server 2003 [aplicativos da área de trabalho | Aplicativos UWP] |
| Plataforma de Destino | Windows |
| Cabeçalho | winbase.h (inclua Windows.h) |
| Biblioteca | Kernel32.lib |
| DLL | Kernel32.dll |