Función GetDiskFreeSpaceW (fileapi.h)

  • Artículo

Recupera información sobre el disco especificado, incluida la cantidad de espacio libre en el disco.

Sintaxis

BOOL GetDiskFreeSpaceW(
  [in]  LPCWSTR lpRootPathName,
  [out] LPDWORD lpSectorsPerCluster,
  [out] LPDWORD lpBytesPerSector,
  [out] LPDWORD lpNumberOfFreeClusters,
  [out] LPDWORD lpTotalNumberOfClusters
);

Parámetros

[in] lpRootPathName

Directorio raíz del disco para el que se va a devolver información. Si este parámetro es NULL, la función usa la raíz del disco actual. Si este parámetro es un nombre UNC, debe incluir una barra diagonal inversa final (por ejemplo, "\\MyServer\MyShare\"). Además, una especificación de unidad debe tener una barra diagonal inversa final (por ejemplo, "C:\"). La aplicación que llama debe tener FILE_LIST_DIRECTORY derechos de acceso para este directorio.

[out] lpSectorsPerCluster

Puntero a una variable que recibe el número de sectores por clúster.

[out] lpBytesPerSector

Puntero a una variable que recibe el número de bytes por sector.

[out] lpNumberOfFreeClusters

Puntero a una variable que recibe el número total de clústeres libres en el disco que están disponibles para el usuario asociado al subproceso que realiza la llamada.

Si las cuotas de disco por usuario están en uso, este valor puede ser menor que el número total de clústeres libres en el disco.

[out] lpTotalNumberOfClusters

Puntero a una variable que recibe el número total de clústeres en el disco que están disponibles para el usuario asociado al subproceso que realiza la llamada.

Si las cuotas de disco por usuario están en uso, este valor puede ser menor que el número total de clústeres del disco.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

La función GetDiskFreeSpaceEx permite evitar algunas de las aritméticas que requiere la función GetDiskFreeSpace .

Comportamiento simbólico del vínculo: si la ruta de acceso apunta a un vínculo simbólico, la operación se realiza en el destino.

Nota

El encabezado fileapi.h define GetDiskFreeSpace como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito Value
Cliente mínimo compatible Windows XP [aplicaciones de escritorio | aplicaciones para UWP]
Servidor mínimo compatible Windows Server 2003 [aplicaciones de escritorio | aplicaciones para UWP]
Plataforma de destino Windows
Encabezado fileapi.h (incluya Windows.h)
Library Kernel32.lib
Archivo DLL Kernel32.dll

Vea también

Funciones de administración de discos

GetDiskFreeSpaceEx

GetDriveType