Функция SetVolumeLabelA (winbase.h)

Статья
03/13/2024

Задает метку тома файловой системы.

Синтаксис

BOOL SetVolumeLabelA(
  [in, optional] LPCSTR lpRootPathName,
  [in, optional] LPCSTR lpVolumeName
);

Параметры

[in, optional] lpRootPathName

Указатель на строку, содержащую букву диска тома (например, X:) или путь к подключенной папке, связанной с томом (например, Y:\MountX). Строка должна заканчиваться обратной косой чертой (''). Если этот параметр имеет значение NULL, используется корень текущего каталога.

[in, optional] lpVolumeName

Указатель на строку, содержащую новую метку для тома. Если этот параметр имеет значение NULL, функция удаляет все существующие метки из указанного тома и не назначает новую метку.

Возвращаемое значение

Если функция выполняется успешно, возвращается ненулевое значение.

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Метка — это понятное имя, которое пользователь присваивает тому, чтобы упростить распознавание. Том может иметь метку, букву диска, и то, и другое. Дополнительные сведения см. в разделе Именование тома.

В Windows 8 и Windows Server 2012 эта функция поддерживается следующими технологиями.

Технология	Поддерживается
Протокол SMB 3.0	Нет
SMB 3.0 Transparent Failover (TFO)	Нет
SMB 3.0 с масштабируемыми общими папками (SO)	Нет
Файловая система общего тома кластера (CSVFS)	Да
Восстанавливаемая файловая система (ReFS)	Да

SMB не поддерживает функции управления томами.

Примечание

Заголовок winbase.h определяет SetVolumeLabel в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование	Значение
Минимальная версия клиента	Windows XP [классические приложения \| Приложения UWP]
Минимальная версия сервера	Windows Server 2003 [классические приложения \| Приложения UWP]
Целевая платформа	Windows
Header	winbase.h (включая Windows.h)
Библиотека	Kernel32.lib
DLL	Kernel32.dll

См. также

GetVolumeInformation

Функции управления томами