IDvdInfo2::GetCmdFromEvent

  • Article
 
Microsoft DirectShow 9.0

IDvdInfo2::GetCmdFromEvent

The GetCmdFromEvent method retrieves an IDvdCmd object from an EC_DVD_CMD_START or EC_DVD_CMD_END event.

Syntax

  HRESULT GetCmdFromEvent(
  LONG_PTR lParam1,
  IDvdCmd **ppCmdObj
);

Parameters

lParam1

[in] Event notification's lParam1 parameter.

ppCmdObj

[out] Address of a pointer to an IDvdCmd command object that is associated with the command that fired the event.

Return Values

Returns one of the following HRESULT values.

Return code Description
S_OK Success.
E_FAIL The command no longer exists.
E_POINTER Invalid argument.

Remarks

This method maps the lParam1 parameter of an EC_DVD_CMD_START or EC_DVD_CMD_END event into an IDvdCmd object that is associated with the command that fired the event. You can then call WaitForStart or WaitForEnd to control the blocking behavior of the DVD Navigator with respect to that command. The IDvdCmd object is created by the DVD Navigator and the returned pointer has already had its reference count incremented, so you must release it after WaitForStart or WaitForEnd returns.

Requirements

Header: Declared in Strmif.h; include Dshow.h.

Library: Use Strmiids.lib.

See Also