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

Статья
11/20/2024

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

Синтаксис

BOOL SetVolumeLabelW(
  [in, optional] LPCWSTR lpRootPathName,
  [in, optional] LPCWSTR lpVolumeName
);

Параметры

[in, optional] lpRootPathName

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

[in, optional] lpVolumeName

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

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

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

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

Замечания

Максимальная длина метки тома составляет 32 символа.

файловой системы FAT: максимальная длина метки тома составляет 11 символов.

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

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

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

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

Заметка

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

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows XP [классические приложения \| Приложения UWP]
минимальный поддерживаемый сервер	Windows Server 2003 [классические приложения \| Приложения UWP]
целевая платформа	Виндоус
заголовка	winbase.h (включая Windows.h)
библиотеки	Kernel32.lib
DLL	Kernel32.dll

См. также

GetVolumeInformation

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

Поделиться через