Функция GetVolumeInformationA (fileapi.h)

Извлекает сведения о файловой системе и томе, связанном с указанным корневым каталогом.

Чтобы указать дескриптор при получении этих сведений, используйте функцию GetVolumeInformationByHandleW .

Чтобы получить текущее состояние сжатия файла или каталога, используйте FSCTL_GET_COMPRESSION.

Синтаксис

BOOL GetVolumeInformationA(
  [in, optional]  LPCSTR  lpRootPathName,
  [out, optional] LPSTR   lpVolumeNameBuffer,
  [in]            DWORD   nVolumeNameSize,
  [out, optional] LPDWORD lpVolumeSerialNumber,
  [out, optional] LPDWORD lpMaximumComponentLength,
  [out, optional] LPDWORD lpFileSystemFlags,
  [out, optional] LPSTR   lpFileSystemNameBuffer,
  [in]            DWORD   nFileSystemNameSize
);

Параметры

[in, optional] lpRootPathName

Указатель на строку, содержащую корневой каталог описываемого тома.

Если этот параметр имеет значение NULL, используется корень текущего каталога. Требуется обратная косая черта в конце. Например, укажите \\MyServer\MyShare как "\\MyServer\MyShare\" или диск C как "C:\".

[out, optional] lpVolumeNameBuffer

Указатель на буфер, получающий имя указанного тома. Размер буфера определяется параметром nVolumeNameSize .

[in] nVolumeNameSize

Длина буфера имени тома в TCHAR. Максимальный размер буфера — MAX_PATHs+1.

Этот параметр игнорируется, если буфер имени тома не указан.

[out, optional] lpVolumeSerialNumber

Указатель на переменную, которая получает серийный номер тома.

Этот параметр может иметь значение NULL , если серийный номер не требуется.

Эта функция возвращает серийный номер тома, который назначается операционной системой при форматировании жесткого диска. Чтобы программно получить серийный номер жесткого диска, назначенный производителем, используйте инструментарий управления Windows (WMI) Win32_PhysicalMedia свойство SerialNumber.

[out, optional] lpMaximumComponentLength

Указатель на переменную, которая получает максимальную длину (в TCHAR) компонента имени файла, который поддерживает указанная файловая система.

Компонент имени файла — это часть имени файла между обратными косыми чертами.

Значение, хранящееся в переменной , на которую указывает *lpMaximumComponentLength , используется для указания того, что указанная файловая система поддерживает длинные имена. Например, для файловой системы FAT, поддерживающей длинные имена, функция сохраняет значение 255, а не предыдущий индикатор 8.3. Длинные имена также поддерживаются в системах, использующих файловую систему NTFS.

[out, optional] lpFileSystemFlags

Указатель на переменную, получающую флаги, связанные с указанной файловой системой.

Этот параметр может быть одним или несколькими из следующих флагов. Однако FILE_FILE_COMPRESSION и FILE_VOL_IS_COMPRESSED являются взаимоисключающими.

[out, optional] lpFileSystemNameBuffer

Указатель на буфер, который получает имя файловой системы, например файловой системы FAT или файловой системы NTFS. Размер буфера определяется параметром nFileSystemNameSize .

[in] nFileSystemNameSize

Длина буфера имен файловой системы в TCHAR. Максимальный размер буфера составляет MAX_PATH+1.

Этот параметр игнорируется, если буфер имен файловой системы не указан.

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

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

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

Комментарии

Когда пользователь пытается получить сведения о дискете, на котором нет дискеты, или компакт-диска без компакт-диска, в системе отображается окно сообщения, в котором пользователь должен вставить гибкий диск или компакт-диск соответственно. Чтобы система не отображала это окно сообщения, вызовите функцию SetErrorMode с SEM_FAILCRITICALERRORS.

Флаг FILE_VOL_IS_COMPRESSED является единственным индикатором сжатия на основе объема. Имя файловой системы не изменяется для указания сжатия, например, этот флаг возвращается для тома DoubleSpace. Если сжатие основано на томе, весь том сжимается или не сжимается.

Флаг FILE_FILE_COMPRESSION указывает, поддерживает ли файловая система сжатие на основе файлов. Если сжатие основано на файлах, отдельные файлы можно сжимать или не сжимать.

Флаги FILE_FILE_COMPRESSION и FILE_VOL_IS_COMPRESSED являются взаимоисключающими. Оба бита не могут быть возвращены набором.

Значение максимальной длины компонента, хранящееся в lpMaximumComponentLength , является единственным показателем того, что том поддерживает имена файловой системы FAT (или другой файловой системы) длиннее обычного. Имя файловой системы не изменяется, чтобы указать на поддержку длинных имен файлов.

Функция GetCompressedFileSize получает сжатый размер файла. Функция GetFileAttributes может определить, сжимается ли отдельный файл.

Поведение символьных ссылок

Если путь указывает на символьную ссылку, функция возвращает сведения о томе для целевого объекта.

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

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

Транзакция операций

Если том поддерживает транзакции файловой системы, функция возвращает FILE_SUPPORTS_TRANSACTIONS в lpFileSystemFlags.

Требования

См. также

Сведения о KTM

Шифрование файлов

GetCompressedFileSize

GetFileAttributes

GetVolumeInformationByHandleW

SetErrorMode

SetVolumeLabel

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