Microsoft DirectX 9.0

IDvdInfo::GetRoot

Note   The IDvdInfo interface is deprecated. Use IDvdInfo2 instead.

Retrieves the root directory that is set in the player.

Syntax

HRESULT GetRoot(
    LPSTR pRoot,
    ULONG cbBufSize,
    ULONG *pcbActualSize
);

Parameters

pRoot

[out, size_is(cbBufSize)] Pointer to the buffer to receive the root string. Note that the root string uses ANSI characters.

cbBufSize

[in] Size of buffer passed in, in bytes.

pcbActualSize

[out] 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.

See Also