Share via

3.2.4.4.1.21 IVolumeClient::EnumLocalFileSystems (Opnum 24)

  • Article

The EnumLocalFileSystems method enumerates the file systems present on the server.<83>

 HRESULT EnumLocalFileSystems(
   [out] unsigned long* fileSystemCount,
   [out, size_is(,*fileSystemCount)] 
     FILE_SYSTEM_INFO** fileSystemList
 );

fileSystemCount: Pointer to the number of elements returned in fileSystemList.

fileSystemList: Pointer to an array of FILE_SYSTEM_INFO structures that represent the file systems present on the server. Memory for the array is allocated by the server and freed by the client.

Return Values: The method MUST return 0 or a nonerror HRESULT on success, or an implementation-specific nonzero error code on failure (as specified in [MS-ERREF]; see also section 2.2.1 for HRESULT values predefined by the Disk Management Remote Protocol).

Upon receiving this message, the server MUST validate parameters:

  1. Verify that fileSystemCount and fileSystemList are not NULL.

If parameter validation fails, the server MUST fail the operation immediately, returning an appropriate error as its response to the client.

Otherwise, the server MUST compose a response to the client as follows:

  1. Enumerate all file system objects from the list of storage objects.

  2. Allocate a buffer large enough to contain FILE_SYSTEM_INFO structures that describe all enumerated file systems.

  3. Populate each FILE_SYSTEM_INFO structure in the buffer with information about the file system.

  4. The buffer MUST be returned to the client in the output parameter fileSystemList.

  5. The number of FILE_SYSTEM_INFO structures in the buffer MUST be returned in the output parameter fileSystemCount.

  6. Return a response that contains the output parameters mentioned previously and the status of the operation.

The server MUST NOT change the list of storage objects as part of processing this message.