MyFSD_GetDiskFreeSpaceW (Windows CE 5.0)

Send Feedback

This function obtains information about the amount of space available on a disk volume in an installable file system. Applications should not call this function directly. Instead, use the corresponding standard Win32 function GetDiskFreeSpaceEx. The FSD Manager determines the file system type and calls the MyFSD_GetDiskFreeSpaceW implementation of the function.

BOOLMyFSD_GetDiskFreeSpaceW( PVOLUMEpVolume,PCWSTR pwsPathName, PDWORD pSectorsPerCluster,PDWORD pBytesPerSector, PDWORD pFreeClusters,PDWORD pClusters);

Parameters

  • pVolume
    [in] Pointer to the value that an FSD defines in its DLL and passes to the FSDMGR_RegisterVolume function when registering the volume. The definition of pVolume can point to private structures.
  • pwsPathName
    [in] Pointer to a null-terminated string that specifies a directory in the file system to on which to return information. Note that the concept of a current directory does not exist. You must specify the complete directory path.
  • pSectorsPerCluster
    [out] Pointer to a variable that receives the number of sectors per cluster.
  • pBytesPerSector
    [out] Pointer to a variable that receives the number of bytes per sector.
  • pFreeClusters
    [out] Pointer to a variable that receives the total number of free clusters on the disk that are available to the user associated with the calling thread.
  • pClusters
    [out] Pointer to a variable that receives the total number of clusters on the disk that are available to the user associated with the calling thread.

Return Values

Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

An FSD exports this function, if it wants to support the GetDiskFreeSpaceEx function. All FSD functions can be called on re-entry; therefore, FSD developers must take this into account when developing an FSD.

The Fsdmgr component is a DLL that manages all OS interaction with installable files systems. Each installable file system requires an FSD, which is a DLL that exports an API needed to support an installable file system. The name of the DLL for an FSD and the names of the functions it exports start with the name of the associated installable file system. For example, if the name of file system is MyFSD, then its DLL is MyFSD.dll and its exported functions are prefaced with MyFSD_*.

Fsdmgr provides service functions to FSDs. The FSDMGR_RegisterVolume, FSDMGR_CreateFileHandle, and FSDMGR_CreateSearchHandle functions record a DWORD of volume-specific data an FSD needs to keep associated with volume. This volume-specific data is passed as the first parameter of these three functions.

Applications that access an installable file system use standard Win32 functions. For example, when an application wants to create a folder on a device that contains an installable file system, it calls CreateDirectory. Fsdmgr recognizes that the path is to a device containing an installable file system and calls the appropriate function, which in the case of the MyFSD file system is MyFSD_CreateDirectoryW. That is, the application calls CreateDirectory, causing Fsdmgr to call **MyFSD_CreateDirectoryW.

Requirements

OS Versions: Windows CE 2.10 and later.
Header: Fsdmgr.h.
Link Library: Fsdmgr.lib.

See Also

CreateDirectory | FSDMGR_CreateSearchHandle | GetDiskFreeSpaceEx | FSDMGR_CreateFileHandle | FSDMGR_RegisterVolume | MyFSD_CreateDirectoryW

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.