ShowDiagsDialog method

Description

VWorks software calls the ShowDiagsDialog method to tell the plugin to open its diagnostics dialog box. This method displays both modal and modeless dialog boxes.

IMPORTANT To properly inform VWorks software that the diagnostics dialog box is closed, the plugin must call the IWorksController OnCloseDiagsDialog method; otherwise, VWorks software assumes that the dialog box is still open and returns an error. See “OnCloseDiagsDialog method” .

Agilent Technologies provides a standard diagnostics dialog box that contains two tabs: one tab for specifying profile settings and the other for controlling the device and viewing device status.

For complex devices, developers of VWorks plugins might want to add controls and components to the standard diagnostics dialog box such as the following:

•	Tabs that enable additional functionality

•	Embedded tab controls or command buttons that allow the user to access the device vendor’s software

Syntax

 

HRESULT ShowDiagsDialog( [in] enum SecurityLevel iSecurity, [in] VARIANT_BOOL bModal );

Parameters

 

iSecurity

[in] Represents the security level, or access privilege, for the user currently logged in to VWorks software. VWorks software determines the functions that a user can perform in the diagnostics dialog box according to the user’s access level privilege. Note: Refer to the VWorks Automation Control Setup Guide for more information about user accounts and privileges. Possible values: 0 = The access level privilege for the current user is Administrator (SECURITY_LEVEL_ADMINISTRATOR) 1 = The access level privilege for the current user is Technician (SECURITY_LEVEL_TECHNICIAN) 2 = The access level privilege for the current user is Operator (SECURITY_LEVEL_OPERATOR) 3 = The access level privilege for the current user is Guest (SECURITY_LEVEL_GUEST) -1 = No user is currently logged in to VWorks software (SECURITY_LEVEL_NO_ACCESS)

bModal

[in] Indicates whether the plugin should display a modal or a modeless dialog box. Possible values: -1 = Display a modal dialog box (VARIANT_TRUE) 0 = Display a modeless dialog box (VARIANT_FALSE)

Related information

 

For information about...	See...
CloseDiagsDialog method	“CloseDiagsDialog method”
IWorksController OnCloseDiagsDialog method	“OnCloseDiagsDialog method”