IDvdInfo::GetRoot method (strmif.h)

  • Article

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

Note  The IDvdInfo interface is deprecated. Use IDvdInfo2 instead.
 
Retrieves the root directory that is set in the player.

Syntax

HRESULT GetRoot(
  [out] LPSTR pRoot,
  [in]  ULONG ulBufSize,
  [out] ULONG *pulActualSize
);

Parameters

[out] pRoot

Pointer to the buffer to receive the root string. Note that the root string uses ANSI characters.

[in] ulBufSize

Size of buffer passed in, in bytes.

[out] pulActualSize

Pointer to a value containing the size of the actual data returned.

Return value

Returns an HRESULT value.

Return code Description
E_UNEXPECTED
 DVD is not initialized or domain is not DVD_DOMAIN_Title.
S_OK
 Success.
VFW_E_DVD_INVALIDDOMAIN
 Requested action is not supported on this domain (DVD_DOMAIN).
VFW_E_DVD_OPERATION_INHIBITED
 Requested action cannot occur at this point in the movie due to the authoring of the current DVD-Video disc.

Remarks

If a valid root was found, this method returns the root string. Otherwise, it returns zero for pcbActualSize, indicating that a valid root directory has not been found or initialized.

Requirements

Requirement Value
Target Platform Windows
Header strmif.h (include Dshow.h)

See also

Error and Success Codes

IDvdInfo Interface