Función GetVolumeInformationA (fileapi.h)

Recupera información sobre el sistema de archivos y el volumen asociado al directorio raíz especificado.

Para especificar un identificador al recuperar esta información, use la función GetVolumeInformationByHandleW .

Para recuperar el estado de compresión actual de un archivo o directorio, use FSCTL_GET_COMPRESSION.

Sintaxis

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
);

Parámetros

[in, optional] lpRootPathName

Puntero a una cadena que contiene el directorio raíz del volumen que se va a describir.

Si este parámetro es NULL, se usa la raíz del directorio actual. Se requiere una barra diagonal inversa final. Por ejemplo, especifique \\MyServer\MyShare como "\\MyServer\MyShare\" o la unidad C como "C:\".

[out, optional] lpVolumeNameBuffer

Puntero a un búfer que recibe el nombre de un volumen especificado. El tamaño del búfer se especifica mediante el parámetro nVolumeNameSize .

[in] nVolumeNameSize

Longitud de un búfer de nombres de volumen, en TCHAR. El tamaño máximo del búfer es MAX_PATHs+1.

Este parámetro se omite si no se proporciona el búfer de nombres de volumen.

[out, optional] lpVolumeSerialNumber

Puntero a una variable que recibe el número de serie del volumen.

Este parámetro puede ser NULL si no se requiere el número de serie.

Esta función devuelve el número de serie del volumen que asigna el sistema operativo cuando se da formato a un disco duro. Para obtener mediante programación el número de serie del disco duro que asigna el fabricante, use el Instrumental de administración de Windows (WMI) Win32_PhysicalMedia propiedad SerialNumber.

[out, optional] lpMaximumComponentLength

Puntero a una variable que recibe la longitud máxima, en TCHAR, de un componente de nombre de archivo que admite un sistema de archivos especificado.

Un componente de nombre de archivo es la parte de un nombre de archivo entre barras diagonales inversas.

Valor almacenado en la variable a la que *lpMaximumComponentLength apunta a se usa para indicar que un sistema de archivos especificado admite nombres largos. Por ejemplo, para un sistema de archivos FAT que admite nombres largos, la función almacena el valor 255, en lugar del indicador anterior 8.3. Los nombres largos también se pueden admitir en sistemas que usan el sistema de archivos NTFS.

[out, optional] lpFileSystemFlags

Puntero a una variable que recibe marcas asociadas al sistema de archivos especificado.

Este parámetro puede ser una o varias de las marcas siguientes. Sin embargo, FILE_FILE_COMPRESSION y FILE_VOL_IS_COMPRESSED son mutuamente excluyentes.

[out, optional] lpFileSystemNameBuffer

Puntero a un búfer que recibe el nombre del sistema de archivos, por ejemplo, el sistema de archivos FAT o el sistema de archivos NTFS. El parámetro nFileSystemNameSize especifica el tamaño del búfer.

[in] nFileSystemNameSize

Longitud del búfer de nombres del sistema de archivos, en TCHAR. El tamaño máximo del búfer es MAX_PATH+1.

Este parámetro se omite si no se proporciona el búfer de nombres del sistema de archivos.

Valor devuelto

Si se recupera toda la información solicitada, el valor devuelto es distinto de cero.

Si no se recupera toda la información solicitada, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Cuando un usuario intenta obtener información sobre una unidad de disquete que no tiene un disco disquete o una unidad CD-ROM que no tiene un disco compacto, el sistema muestra un cuadro de mensaje para que el usuario inserte un disco disquete o un disco compacto, respectivamente. Para evitar que el sistema muestre este cuadro de mensaje, llame a la función SetErrorMode con SEM_FAILCRITICALERRORS.

La marca FILE_VOL_IS_COMPRESSED es el único indicador de compresión basada en volumen. El nombre del sistema de archivos no se modifica para indicar la compresión, por ejemplo, se devuelve esta marca establecida en un volumen DoubleSpace. Cuando la compresión está basada en volumen, un volumen completo se comprime o no se comprime.

La marca FILE_FILE_COMPRESSION indica si un sistema de archivos admite la compresión basada en archivos. Cuando la compresión se basa en archivos, los archivos individuales se pueden comprimir o no comprimir.

Las marcas FILE_FILE_COMPRESSION y FILE_VOL_IS_COMPRESSED son mutuamente excluyentes. No se pueden devolver ambos bits.

El valor de longitud máxima del componente almacenado en lpMaximumComponentLength es el único indicador de que un volumen admite nombres de archivo FAT más largos de lo normal (u otro sistema de archivos). El nombre del sistema de archivos no se modifica para indicar la compatibilidad con nombres de archivo largos.

La función GetCompressedFileSize obtiene el tamaño comprimido de un archivo. La función GetFileAttributes puede determinar si un archivo individual está comprimido.

Comportamiento simbólico del vínculo

Si la ruta de acceso apunta a un vínculo simbólico, la función devolverá información de volumen del destino.

A partir de Windows 8 y Windows Server 2012, esta función es compatible con las siguientes tecnologías.

SMB no admite funciones de administración de volúmenes.

Operaciones de transacción

Si el volumen admite transacciones del sistema de archivos, la función devuelve FILE_SUPPORTS_TRANSACTIONS en lpFileSystemFlags.

Requisitos

Vea también

Acerca de KTM

Cifrado de archivos

GetCompressedFileSize

GetFileAttributes

GetVolumeInformationByHandleW

SetErrorMode

SetVolumeLabel

Funciones de administración de volúmenes