MSVidWebDVD.GPRM Property

Article
07/09/2010

Note This topic applies to Windows XP Service Pack 1 or later.

The GPRM property specifies and retrieves the specified general parameter register.

VidWebDVD.GPRM(
   lIndex As Long
) As Short

Parameters

lIndex
Long specifying the general parameter register. The value must range from 0 through 15.

Return Value

When getting the value, this property returns a Short.

Error Codes

If the property fails, Err.Number may be set to one of the following values.

Value	Description
E_UNEXPECTED	Unspecified error.
E_INVALIDARG	Index is less than 0 or greater than 15.

Valid Domains

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

Remarks

General parameter registers, or GPRMs, are 16-bit registers that each disc can use in unique ways for temporary data storage. A player application does not need to access these registers for any standard playback or navigation control using the MSVidWebDVD object. This method is provided for player applications implementing advanced functionality. Do not attempt to modify the GPRMs directly unless you have a thorough knowledge of the DVD specification and the ways in which the GPRMs are used on the particular disc to be played. Changing these values can result in unpredictable behavior.

Examples

' Setting the property.
VidWebDVD.GPRM(lIndex) = sRegister
' Returning the property.
sRegister = VidWebDVD.GPRM(lIndex)

Requirements

Type Library	MS Video Control 1.0 Type Library and Microsoft Tuner 1.0 Type Library
DLL	Quartz.dll