Share via

IDvdControl2::SetGPRM

  • Article
 
Microsoft DirectShow 9.0

IDvdControl2::SetGPRM

The SetGPRM method sets a general parameter register value.

Syntax

  HRESULT SetGPRM(
  ULONG ulIndex,
  WORD wValue,
  DWORD dwFlags,
  IDvdCmd **ppCmd
);

Parameters

ulIndex

[in] Register index; may be a value from zero through 15.

wValue

[in] A 16-bit value contained in the specified register.

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 Values

Returns one of the following values.

Return code Description
S_OK Success.
E_INVALIDARG The ulIndex parameter is greater than 15 or any other of the input parameters are invalid.

Remarks

A DVD disc uses general parameter registers to store various types of information. By manually setting one or more of these registers, an application might be able to provide certain custom functionality. This is an advanced command and should not be used unless you have a thorough understanding of the DVD specification.

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
none All

Requirements

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

Library: Use Strmiids.lib.

See Also