Compartir a través de

Función SHGetDiskFreeSpaceExA (shellapi.h)

  • Artículo

Recupera información de espacio en disco para un volumen de disco.

Sintaxis

BOOL SHGetDiskFreeSpaceExA(
  [in]            LPCSTR         pszDirectoryName,
  [out, optional] ULARGE_INTEGER *pulFreeBytesAvailableToCaller,
  [out, optional] ULARGE_INTEGER *pulTotalNumberOfBytes,
  [out, optional] ULARGE_INTEGER *pulTotalNumberOfFreeBytes
);

Parámetros

[in] pszDirectoryName

Tipo: LPCTSTR de

Cadena terminada en NULL que especifica el volumen para el que se recupera la información de tamaño. Puede ser una letra de unidad, un nombre UNC o la ruta de acceso de una carpeta. No puede usar NULL para representar la unidad actual.

[out, optional] pulFreeBytesAvailableToCaller

Tipo: ULARGE_INTEGER*

Puntero a un valor que recibe el número de bytes del volumen disponible para la aplicación que llama. Si el sistema operativo implementa cuotas por usuario, este valor puede ser menor que el número total de bytes libres en el volumen.

[out, optional] pulTotalNumberOfBytes

Tipo: ULARGE_INTEGER*

Puntero a un valor que recibe el tamaño total del volumen, en bytes.

[out, optional] pulTotalNumberOfFreeBytes

Tipo: ULARGE_INTEGER*

Puntero a un valor que recibe el número de bytes de espacio libre en el volumen.

Valor devuelto

Tipo: BOOL de

Devuelve TRUE si se ejecuta correctamente, FALSE de lo contrario.

Observaciones

La función con nombre similar SHGetDiskFreeSpace es simplemente un alias para SHGetDiskFreeSpaceEx. Al llamar a SHGetDiskFreeSpace realmente llama a esta función.

Esta función llama a la función GetDiskFreeSpaceEx si está disponible en el sistema operativo. Si GetDiskFreeSpaceEx no está disponible, se emula llamando a la función GetDiskFreeSpace y manipulando los valores devueltos. Para obtener más información, consulte la documentación de GetDiskFreeSpaceEx.

Nota

El encabezado shellapi.h define SHGetDiskFreeSpaceEx 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 Conventions for Function Prototypes.

Requisitos

Requisito Valor
cliente mínimo admitido Windows 2000 Professional, Windows XP [solo aplicaciones de escritorio]
servidor mínimo admitido Windows Server 2003 [solo aplicaciones de escritorio]
de la plataforma de destino de Windows
encabezado de shellapi.h
biblioteca de Shell32.lib
DLL de Shell32.dll (versión 5.0 o posterior)

Consulte también

GetDiskFreeSpaceEx

SHGetDiskFreeSpace