IMDSPStorageGlobals::GetTotalFree

  • Article
banner art

The GetTotalFree method retrieves the total free space on the storage medium, in bytes.

Syntax

HRESULT GetTotalFree(DWORD*pdwFreeLow,DWORD*pdwFreeHigh);

Parameters

pdwFreeLow

[out]  Pointer to a DWORD containing the low-order bytes of the free space.

pdwFreeHigh

[out]  Pointer to a DWORD containing the high-order bytes of the free space.

Return Values

The method returns an HRESULT. All the interface methods in Windows Media Device Manager can return any of the following classes of error codes:

  • Standard COM error codes
  • Windows error codes converted to HRESULT values
  • Windows Media Device Manager error codes

For an extenstive list of possible error codes, see Error Codes.

Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK The method succeeded.
E_INVALIDARG Either pdwFreeLow or pdwFreeHigh is an invalid or NULL pointer.
E_FAIL An unspecified error occurred.

Remarks

To determine the amount of storage space in use by the medium for file management, subtract the number of bad bytes identified by using GetTotalBad from the number of free bytes identified by using GetTotalFree.

This method must be implemented. It must not return WMDM_E_NOTSUPPORTED or E_NOTIMPL. For more information, see Mandatory and Optional Interfaces.

Requirements

Header: Defined in mswmdm.h.

Library: mssachlp.lib

See Also