GetGPRM Method

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

Note

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.

[ iGPRM = ] MSWebDVD.GetGPRM(iIndex)

Parameters

iIndex

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

Return Value

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

SetGPRM