IMDSPObjectInfo::SetPlayLength (deprecated)

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 SetPlayLength method sets the play length of the object, in units pertinent to the object. This is the maximum length that the object plays regardless of its actual length.

Syntax

HRESULT SetPlayLength(
  DWORD  dwLength
);

Parameters

dwLength

[in]  DWORD containing the play length to set for the object, in units pertinent to 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 device does not support setting play lengths.
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

If the value passed in is greater than the total length of the object, it is clipped to the length of the object minus the object's current play position minus one unit.

For playable files, the value to set is specified in milliseconds. The value is clipped to no more than the total length of the file minus the object's current play offset position. The play position 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 passed is the number 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