IDvdInfo2::GetCmdFromEvent method

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

Syntax


HRESULT GetCmdFromEvent(
  [in]  LONG_PTR lParam1,
  [out] IDvdCmd  **ppCmdObj
);

Parameters

lParam1 [in]

Event notification's lParam1 parameter.

ppCmdObj [out]

Receives a pointer to the IDvdCmd interface that is associated with the command that fired the event.

Return value

Returns one of the following HRESULT values.

Return codeDescription
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

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Strmif.h (include Dshow.h)

Library

Strmiids.lib

See also

DVD Applications
Error and Success Codes
IDvdInfo2 Interface
Synchronizing DVD Commands

 

 

Show: