GetGPRM Method

 
Microsoft DirectShow 9.0

GetGPRM Method

This component is available for use in the Microsoft Windows 2000, Windows XP, and Windows Server 2003 operating systems. It may be altered or unavailable in subsequent versions.

The GetGPRM method retrieves the specified general parameter register.

Syntax

[ iGPRM = ] MSWebDVD.GetGPRM(iIndex);

Parameters

iIndex

Specifies the register to retrieve as an Integer. The value must range from 0 through 15.

Return Values

Returns an integer value representing the specified register.

Remarks

This method is not required for any DVD navigation or playback functionality using the MSWebDVD object. It is provided for those with a thorough understanding of the DVD specification who want to implement advanced features. GPRMs can be used to hold any values, so they can be freely set and read. But since GPRMs are used to store disc commands as well, changing their values using SetGPRM can result in unpredictable behavior.

See Also