gIEDebugGUI Interface Reference

List of all members.

Public Member Functions
HRESULT	DebugDialog ()
HRESULT	GetDeviceHandle (T_HANDLE *pHandle)
HRESULT	SetDebugParam ([in] BSTR key,[in] BSTR value)
HRESULT	GetDebugParam ([in] BSTR key,[out] BSTR *p_value)
HRESULT	GetIEUSBHandle (T_IEUSB_HANDLE *pHandle)

---

Detailed Description

A generic interface for presenting internal diagnostic GUI's for debugging.

---

Member Function Documentation

HRESULT DebugDialog

(

)

Displays the component's diagnostic GUI.

HRESULT GetDeviceHandle

(

T_HANDLE *

pHandle

)

Returns the current HANDLE to the device or NULL if none exists.

HRESULT SetDebugParam	(	[in] BSTR	key,
		[in] BSTR	value
	)

Sets provider-specific parameters for provider instance. See the description of the provider for specific value-pairs.

HRESULT GetDebugParam	(	[in] BSTR	key,
		[out] BSTR *	p_value
	)

Gets provider-specific parameters for provider instance. See the description of the provider for specific value-pairs. Note that *ALL* service providers should support the read-only parameter of "version" which returns build/version info on the provider as follows:

                    strVersion.Format("%i.%.2i - %s",MAJOR_VERSION,MINOR_VERSION,__TIMESTAMP__);

Additionally, if the hardware supports native timestamping the read-only property "hwtimestamp" will be exposed and will always return a value of '1'. (Hardware without native timestamps will not implement this property.)

HRESULT GetIEUSBHandle

(

T_IEUSB_HANDLE *

pHandle

)

Returns the IEUSB_HANDLE or NULL if none exists.

---