IDvdControl2::ShowMenu method

The ShowMenu method displays the specified menu, if available.

Syntax


HRESULT ShowMenu(
  [in]  DVD_MENU_ID MenuID,
  [in]  DWORD       dwFlags,
  [out] IDvdCmd     **ppCmd
);

Parameters

MenuID [in]

A DVD_MENU_ID enumeration value that specifies the menu to display.

dwFlags [in]

Bitwise OR of one or more flags from the DVD_CMD_FLAGS enumeration, specifying how to synchronize the command.

ppCmd [out]

Receives a pointer to an IDvdCmd object that can be used to synchronize DVD commands. The caller must release the interface. This parameter can be NULL. For more information, see Synchronizing DVD Commands.

Return value

Returns one of the following values.

Return codeDescription
S_OK

Success.

E_INVALIDARG

The MenuID parameter is invalid.

VFW_E_DVD_INVALIDDOMAIN

Invalid domain.

VFW_E_DVD_MENU_DOES_NOT_EXIST

The specified menu does not exist.

VFW_E_DVD_OPERATION_INHIBITED

UOP control prohibits the operation.

 

Remarks

The Video Manager Menu (VMGM) should be accessible from the Title or the Video Title Set domains. The Video Title Set menus (VTSMs) might only be accessible through the VMGM. Any submenus under each VTSM (for chapters, angles, and audio and subpicture streams) are only accessible through that VTSM.

This method is demonstrated in the DVDSample application application in CDvdCore::RootMenu and CDvdCore::TitleMenu.

The following table shows the Annex J command name to which this method name corresponds, and the domains in which this method is valid.

Annex J Command Name Valid Domains
Menu_CallAll.

 

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
IDvdControl2 Interface
Working With DVD Menus

 

 

Show: