Share via

IWMDMObjectInfo::GetTotalLength (deprecated)

  • Article
banner art

This is preliminary documentation and subject to change.

This topic documents a feature of the Windows Media Device Manager SDK. We recommend that you migrate your application to use the Windows Portable Devices API. For more information, see the Windows Portable Devices SDK.

The GetTotalLength method retrieves the total play length of the object, in units appropriate to the format. The value returned is the total length regardless of the current settings of the play length and offset.

Syntax

HRESULT GetTotalLength(
  DWORD*  pdwLength
);

Parameters

pdwLength

[out]  Pointer to a DWORD specifying the total length of the file, in units appropriate to the format.

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.
WMDM_E_NOTSUPPORTED This object cannot report total play length.
E_INVALIDTYPE The object that this interface is associated with is not a valid playable file or a folder or file system containing playable files.
E_FAIL An unspecified error occurred.

Remarks

For playable files, the total length is specified in milliseconds.

For folders or file systems containing playable files, the value returned indicates the total number of playable files in a folder or in the root of a file system.

Requirements

Header: Defined in mswmdm.h.

Library: mssachlp.lib

See Also