IMDSPObjectInfo::GetPlayLength (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 GetPlayLength method retrieves the play length of the object in units pertinent to the object. This is the remaining length that the object can play, not its total length.

Syntax

HRESULT GetPlayLength(
  DWORD*  pdwLength
);

Parameters

pdwLength

[out]  Pointer to a DWORD containing the remaining play length of the object.

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 the remaining 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

The value of the play length retrieved is either the total length of the object minus the current play position (if the IMDSPObjectInfo::SetPlayLength method has not been called), or the value set by IMDSPObjectInfo::SetPlayLength clipped to be no greater than the total play length of the object minus the current play position.

For playable files, the value returned is specified in milliseconds. The play length information can change either when the user starts playing a file on the media device or when an application invokes the IMDSPDeviceControl::Play method.

For folders or file systems containing playable files, the value returned is in tracks or numbers of playable files in that folder or in the root of that file system.

Requirements

Header: Defined in mswmdm.h.

Library: mssachlp.lib

See Also