Función GetDiskFreeSpaceExA (fileapi.h)

  • Artículo

Recupera información sobre la cantidad de espacio disponible en un volumen de disco, que es la cantidad total de espacio, la cantidad total de espacio libre y la cantidad total de espacio disponible para el usuario asociado al subproceso que realiza la llamada.

Sintaxis

BOOL GetDiskFreeSpaceExA(
  [in, optional]  LPCSTR          lpDirectoryName,
  [out, optional] PULARGE_INTEGER lpFreeBytesAvailableToCaller,
  [out, optional] PULARGE_INTEGER lpTotalNumberOfBytes,
  [out, optional] PULARGE_INTEGER lpTotalNumberOfFreeBytes
);

Parámetros

[in, optional] lpDirectoryName

Un directorio en el disco.

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\".

Este parámetro no tiene que especificar el directorio raíz en un disco. La función acepta cualquier directorio de un disco.

La aplicación que llama debe tener FILE_LIST_DIRECTORY derechos de acceso para este
"samples".

[out, optional] lpFreeBytesAvailableToCaller

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

Este parámetro puede ser NULL.

Si se usan cuotas por usuario, este valor puede ser menor que el número total de bytes libres en un disco.

[out, optional] lpTotalNumberOfBytes

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

Este parámetro puede ser NULL.

Si se usan cuotas por usuario, este valor puede ser menor que el número total de bytes de un disco.

Para determinar el número total de bytes en un disco o volumen, use IOCTL_DISK_GET_LENGTH_INFO.

[out, optional] lpTotalNumberOfFreeBytes

Puntero a una variable que recibe el número total de bytes libres en un disco.

Este parámetro puede ser NULL.

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 (0). Para obtener información de error extendida, llame a GetLastError.

Comentarios

Los valores obtenidos por esta función son del tipo ULARGE_INTEGER. No trunquen estos valores a 32 bits.

La función GetDiskFreeSpaceEx devuelve cero (0) para lpTotalNumberOfFreeBytes y lpFreeBytesAvailable para todas las solicitudes de CD a menos que el disco sea un CD no escrito en una unidad CD-RW.

Comportamiento de vínculo simbólico: 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 GetDiskFreeSpaceEx 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 neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

   
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 (incluye Windows.h)
Library Kernel32.lib
Archivo DLL Kernel32.dll

Vea también

Funciones de administración de discos

GetDiskFreeSpace

GetModuleHandle