Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

IDvdControl2::SetGPRM method

The SetGPRM method sets a general parameter register value.

Syntax


HRESULT SetGPRM(
  [in]  ULONG   ulIndex,
  [in]  WORD    wValue,
  [in]  DWORD   dwFlags,
  [out] 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 value

Returns one of the following values.

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

 

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
IDvdInfo2::GetAllGPRMs

 

 

Community Additions

ADD
Show:
© 2015 Microsoft