DIAdem

https://www.ni.com/docs/en-US/bundle/diadem/
Admin
DIAdem is a National Instruments data management and analysis platform that enables professionals to...
Tokens:203,246
Snippets:2,762
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Do...Loop Until Example

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/general/vbs_doloopuntil.htm

A practical example demonstrating a loop that runs five times, incrementing a counter until the condition is met.

```VBScript
Dim iLoop
iLoop = 1
Do
  Call MsgBox("Loop = " & iLoop)
  iLoop = iLoop + 1
Loop until (iLoop > 5)
```

--------------------------------

### Delete a Folder Example

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/scripting/methods/scripting_method_deletefolder_ifilesystem3.htm

A subroutine demonstrating how to instantiate the FileSystemObject and delete a folder.

```VBScript
Sub DeleteMyFolder(sFile)
   Dim fso
   Set fso = CreateObject("Scripting.FileSystemObject")
   fso.DeleteFolder(sFile)
End Sub
```

--------------------------------

### Generating and Releasing an Object

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/general/vbs_set.htm

Example demonstrating the creation of a FileSystemObject, its usage, and subsequent release from memory.

```vbs
Dim FSO, bExists
Set FSO = CreateObject("Scripting.FileSystemObject")
bExists = FSO.FileExists("C:\Autoexec.bat")
Call MsgBox(bExists)
' further instructions
Set FSO = Nothing
```

--------------------------------

### WizardStart(WIZName, WIZPageName, WIZParam)

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/comoff/wizardstart.htm

Starts a specified DIAdem wizard with optional page and parameter settings.

```APIDOC
## WizardStart

### Description
Starts a wizard in DIAdem.

### Signature
`WizardStart([WIZName], [WIZPageName], [WIZParam])`

### Parameters
- **WIZName** (String) - Optional - Specifies the name of the wizard. Options: "WizChart", "WizReport", "WizDataPlugin". Default is "WizReport".
- **WIZPageName** (String) - Optional - Specifies the start page for the wizard. Used by the Report Wizard (e.g., "INTRODUCTION", "CURVEUSAGE", "LAYOUTSTYLE"). Default is "INTRODUCTION".
- **WIZParam** (String) - Optional - Specifies further parameters for the wizard. Used by the diagram wizard to recognize call origins.
```

--------------------------------

### InstallationInfo(InstallationKeyword)

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/comoff/installationinfo.htm

Retrieves information about the current DIAdem installation based on the provided keyword.

```APIDOC
## InstallationInfo(InstallationKeyword)

### Description
Specifies information about the current installation. Returns a Variant variable containing the requested data.

### Parameters
#### Input Parameters
- **InstallationKeyword** (String) - Required - Specifies the type of installation information requested (e.g., "Base Edition", "Days left", "DIAdem serial number").

### Return Value
- **ReturnValue** (Variant) - The requested installation information.
```

--------------------------------

### RTrim Usage Example

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/methods/vbs_method_rtrim_globalobj.htm

Example demonstrating how to remove trailing spaces from a string and display the result.

```VBS
Dim MyString
MyString = RTrim("    DIAdem   ")
Call MsgBox(MyString) ' Returns "    DIAdem"
```

--------------------------------

### Example of Left Method

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/methods/vbs_method_left_globalobj.htm

Demonstrates extracting the first three characters from the string 'DIAdem'.

```vbs
Dim MyString
MyString = Left("DIAdem", 3)
Call MsgBox(MyString) ' Returns "DIA"
```

--------------------------------

### Retrieve Installation Information Keywords

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/comoff/installationinfo.htm

List of possible keywords used as input parameters for the InstallationInfo command.

```text
"Base Edition"
```

```text
"Advanced Edition"
```

```text
"Professional Edition"
```

```text
"DAC"
```

```text
"DAC Kit"
```

```text
"DAC Bundle"
```

```text
"Crash Analysis Toolkit"
```

```text
"Student Edition"
```

```text
"Evaluation Version"
```

```text
"Days left"
```

```text
"DIAdem serial number"
```

```text
"Crash toolkit serial number"
```

--------------------------------

### Execute Method Usage

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/methods/vbs_method_execute_globalobj.htm

Example demonstrating how to use the Execute method to perform variable assignment.

```vbs
Dim MyVar1, MyVar2
MyVar1 = 1
MyVar2 = 2
Call Execute("MyVar1 = MyVar2 + 1")
Call MsgBox(MyVar1) ' Returns 3
```

--------------------------------

### DataAreaInsert Command Examples

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/comoff/dataareainsert.htm

Examples of using the DataAreaInsert command in VBScript and Python to copy data between channels.

```VBScript
Call DataAreaInsert("Group1/Channel1", 2, 10, "Group1/Channel4", "Group2/Channel1", 1)
```

```Python
dd.DataAreaInsert("Group1/Channel1", 2, 10, "Group1/Channel4", "Group2/Channel1", 1)
```

--------------------------------

### Assigning date/time to WfStartTime

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/comoff/chnwfpropset.htm

Examples demonstrating how to assign date/time type data to the WfStartTime parameter using VBScript and Python.

```VBScript
'Value of date/time type
Dim sVal : sVal = RTT(Now)
Call ChnWfPropSet("[1]/Channel", "Time", "s" , 1, 0.01, sVal)
```

```Python
#Value of date/time type
sVal = dd.RTT(Now) 
dd.ChnWfPropSet("[1]/Channel", "Time", "s" , 1, 0.01, sVal)
```

--------------------------------

### ExecuteGlobal Method Usage

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/methods/vbs_method_execute_globalobj.htm

Example demonstrating how to define and execute a procedure using ExecuteGlobal.

```vbs
Dim MyStr
MyStr = "Sub HelloWorld() : Call MsgBox(""Hello World!"") : End Sub"
Call ExecuteGlobal(MyStr)
Call HelloWorld
```

--------------------------------

### Evaluating Expressions with Eval

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/methods/vbs_method_eval_globalobj.htm

Example demonstrating how to use Eval to compare variables and return boolean results.

```vbs
Dim MyVar1, MyVar2
MyVar1 = 1
MyVar2 = 2
Call MsgBox(Eval("MyVar1 = MyVar2 + 1")) ' Returns False
Call MsgBox(MyVar1)                      ' Returns 1
Call MsgBox(Eval("MyVar1 = MyVar2 - 1")) ' Returns True
```

--------------------------------

### Using GetBarID in Python

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/tobarmanagerint/methods/diabars_method_getbarid_toactionobjpopupint.htm

Example demonstrating how to use GetBarID within a Python script to manage button state.

```Python
oMyObj = dd.BarManager.ActionObjs("MyPopup") 
oMyObj.OnRefreshCode.Code = "If This.GetBarID = ""SCRGroup"" Then" 
    oMyObj.OnRefreshCode.AddCodeLine(" This.Enable = (GlobUsedChn > 0)") 
```

--------------------------------

### Retrieve File Version Example

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/scripting/methods/scripting_method_getfileversion_ifilesystem3.htm

A function wrapper that creates a FileSystemObject and returns the version string for a provided file path.

```VBScript
Function FileVersion(sFile)
  Dim fso
  Set fso = CreateObject("Scripting.FileSystemObject")
  FileVersion = fso.GetFileVersion(sFile)
End Function
```

--------------------------------

### Display Current Year

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/methods/vbs_method_year_globalobj.htm

Example demonstrating how to retrieve and display the current year using the Year and Now functions.

```VBS
Dim iMyYear
iMyYear = Year(Now)
Call MsgBox(iMyYear)
```

--------------------------------

### Retrieve Current Minute

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/methods/vbs_method_minute_globalobj.htm

Example demonstrating how to retrieve the current minute using the Now function and display it in a message box.

```vbs
Dim Myvar
MyVar = Minute(Now)
Call MsgBox(MyVar)
```

--------------------------------

### Adding a Button with a Custom Icon

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/tobarmanagerint/properties/diabars_property_picture_toactionobjpopupint.htm

Example demonstrating how to create an action object, assign an icon, and add it to a toolbar group.

```VBScript
Dim oMyActionObj
If not (BarManager.ActionObjs.Exists("MyObjCheck1")) Then
  Set oMyActionObj = BarManager.ActionObjs.Add("MyObjCheck1", "CustomPopUp") 
  oMyActionObj.Picture = "favicon.ico"
  oMyActionObj.Tooltip = "Opens ANAMain"
  oMyActionObj.BarID   = "ANAMain"
End If
Call BarManager.Bars("SCRGroup").UsedActionObjs.Add(oMyActionObj)
```

```Python
if not (dd.BarManager.ActionObjs.Exists("MyObjCheck1")) : 
    oMyActionObj = dd.BarManager.ActionObjs.Add("MyObjCheck1", "CustomPopUp") 
    oMyActionObj.Picture = "favicon.ico" 
    oMyActionObj.Tooltip = "Opens ANAMain" 
    oMyActionObj.BarID   = "ANAMain" 
dd.BarManager.Bars("SCRGroup").UsedActionObjs.Add(oMyActionObj) 
```

--------------------------------

### Detecting Peaks with ChnPeakDetect

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/comoff/chnpeakdetect.htm

Examples demonstrating how to call the ChnPeakDetect function and access the resulting channel information in VBScript and Python.

```VBScript
Dim sOutput
Set ChnResult = ChnPeakDetect("[1]/Time", "[1]/Speed", "/Position", "/Amplitude", "Peaks", 0, 3)
sOutput = "Results: " & VBCrLf & "Channelgroup: " & ChnResult.Item(1).ChannelGroup.Name & VBCrLf
sOutput =  sOutput & "X-Channel: " & ChnResult.Item(1).Name & VBCrLf & "Y-Channel: " & ChnResult.Item(2).Name
Call MsgBox(sOutput)
```

```Python
dd.ChnResult = dd.ChnPeakDetect("[1]/Time", "[1]/Speed", "/Position", "/Amplitude", "Peaks", 0, 3) 
sOutput = "Results: " + "\r\n" + "Channelgroup: " + dd.ChnResult.Item(1).ChannelGroup.Name + "\r\n" 
sOutput =  sOutput + "X-Channel: " + dd.ChnResult.Item(1).Name + "\r\n" + "Y-Channel: " + dd.ChnResult.Item(2).Name 
print(sOutput)
```

--------------------------------

### InStr(start, string, string2, [compare])

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/methods/vbs_method_instr_globalobj.htm

Returns the position of the first occurrence of string2 within string, starting from the optional start position.

```APIDOC
## InStr(start, string, string2, [compare])

### Description
Specifies the position in the text where a character or a character string appears in the text for the first time.

### Syntax
vInStr = InStr(start, string, string2, [compare])

### Parameters
- **start** (Variant) - Optional - Specifies the start position of the search. If not specified, the search starts with the first character.
- **string** (Variant) - Required - Specifies the text you want to search through.
- **string2** (Variant) - Required - Specifies the character string you want to search for.
- **compare** (Variant) - Optional - Specifies the type of comparison. Possible settings are vbBinaryCompare and vbTextCompare. Defaults to binary comparison.

### Return Value
- **vInStr** (Variant) - Returns the position of the character or string. Returns 0 if not found or if start is greater than string length. Returns Null if string or string2 is Null. Returns 1 if string2 is an empty string.

### Example
```vb
Dim MyPos
MyPos = InStr("abcdabcde", "c")                   'Returns 3
Call MsgBox(MyPos) 
MyPos = InStr("abcdabcde", "C")                   'Returns 0
Call MsgBox(MyPos) 
MyPos = InStr(1, "abcdabcde", "C", vbTextCompare) 'Returns 3
Call MsgBox(MyPos)
```
```

--------------------------------

### Create and write to a file using FileSystemObject

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/scripting/objects/scripting_objects_ifilesystem3.htm

Demonstrates how to instantiate the FileSystemObject, create a text file, write a line of text, and close the file.

```VBScript
Dim fso, MyFile
Set fso = CreateObject("Scripting.FileSystemObject")
Set MyFile= fso.CreateTextFile(ScriptWritePath & "\testfile.txt", True)
MyFile.WriteLine("This is the first line")
MyFile.Close
```

--------------------------------

### ApprAnsatzOff()

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/comoff/appransatzoff.htm

Deletes the selection of all the setup function terms of an approximation.

```APIDOC
## ApprAnsatzOff()

### Description
Deletes the selection of all the setup function terms of an approximation. This command assigns the selection term "-" to all elements of the ApprAnsatzFct vector variable.

### Syntax
`ApprAnsatzOff()`

### Parameters
None
```

--------------------------------

### Calculate Tangent of Pi

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/methods/vbs_method_tan_globalobj.htm

Example demonstrating the calculation of the tangent of the number pi.

```VBS
Call MsgBox(Tan(Pi))
```

--------------------------------

### Define a User Command

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/functions/functions/scriptevaluate.htm

Examples of defining a user command in VBScript and Python.

```VBScript
Function MyCommand(MyPar)
  MyCommand = "Value: " & MyPar
End Function
```

```Python
def MyCommand(MyPar): 
    MyCommand = "Value: " + MyPar 
    return MyCommand
```

--------------------------------

### WizardStart(WizardName)

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/comoff/wizardstart.htm

Initiates a specified wizard by its name.

```APIDOC
## WizardStart(WizardName)

### Description
Starts a wizard identified by the provided name.

### Parameters
- **WizardName** (String) - Required - The identifier of the wizard to start (e.g., "WizChart").

### Usage Example (VBScript)
```vbscript
Call WizardStart("WizChart")
```

### Usage Example (Python)
```python
dd.WizardStart("WizChart")
```
```

--------------------------------

### Create and Configure a Property Value Mapping

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/scriptnavi/objects/navigator_objects_ivaluemappings.htm

Demonstrates creating a value mapper, adding a mapping for the 'name' property at the channel level, and defining a transformation rule.

```VBScript
Dim oMyMapper, oMyChnNameMapping, oMyRule
Set oMyMapper = Navigator.Settings.CreateValueMapper()
Set oMyChnNameMapping = oMyMapper.Mappings(eSearchChannel).Add("name")
Set oMyRule = oMyChnNameMapping.Rules.Add(_
    "([[:alpha:]]+)([\_\-\/\\\?\ \:]+)([[:digit:]]+)","$1~text~$3","Example_1")
MsgBox "Pattern: " & oMyRule.Pattern & vBCrLf _
& "Scheme: " & oMyRule.Schema & vBCrLf _
& "Example to map: " & oMyRule.Example & vBCrLf _
& "Mapped example: " & oMyRule.MapProperty(oMyRule.Example)
```

```Python
oMyMapper = dd.Navigator.Settings.CreateValueMapper() 
oMyChnNameMapping = oMyMapper.Mappings(dd.eSearchChannel).Add("name") 
oMyRule = oMyChnNameMapping.Rules.Add("([[:alpha:]]+)([\\_\\-\/\\\\\\?\\ \\:]+)([[:digit:]]+)","$1~text~$3","Example_1") 
print "Pattern: " + oMyRule.Pattern + "\r\n" + "Scheme: " + oMyRule.Schema + "\r\n" + "Example to map: " + oMyRule.Example + "\r\n" + "Mapped example: " + oMyRule.MapProperty(oMyRule.Example) 
```

--------------------------------

### DataBlClpPaste

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/comoff/datablclppaste.htm

Pastes a data block from the clipboard into the specified channels starting at the given row.

```APIDOC
## DataBlClpPaste

### Description
Pastes a data block from the clipboard into the specified channels starting at the given row.

### Parameters
- **oMyChannelList** (Object) - Required - The list of channels where the data block will be pasted.
- **Row** (Integer) - Required - The starting row index for the paste operation.
```

--------------------------------

### Checking a variable value with vbTrue

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/properties/vbs_property_vbtrue_globalobj.htm

Example demonstrating how to compare a variable against the vbTrue constant.

```VBS
Dim bValue
bValue = True
If bValue = vbTrue Then
  Call MsgBox("Value is 'True'")
End If
```

--------------------------------

### Generating a user-defined error

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/properties/vbs_property_vbobjecterror_globalobj.htm

Example of using vbObjectError to raise a custom error number.

```VBS
Err.Raise Number = vbObjectError + 1000
```

--------------------------------

### Launch Chart Wizard

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/comoff/wizardstart.htm

Initiates the Chart Wizard using the WizardStart command. Use the appropriate syntax for your scripting environment.

```VBScript
Call WizardStart("WizChart")
```

```Python
dd.WizardStart("WizChart")
```

--------------------------------

### Configure and Open a Database Connection

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/ado/ado/ado_general.htm

Sets the connection string parameters and opens the database connection.

```VBScript
oDBConn.ConnectionString = "Provider=" & "Microsoft.ACE.OLEDB.12.0; Data Source= c:\Test_DB.mdb"
oDBConn.Open
```

--------------------------------

### Creating and Configuring Action Objects

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/tobarmanagerint/objects/diabars_objects_toactionobjpopupint.htm

Demonstrates how to initialize a custom bar, add action buttons, and create a popup object using the BarManager API.

```python
if not dd.BarManager.Bars.Exists("MyBar") : 
    oMyBar = dd.BarManager.Bars.Add("MyBar") 
else: 
    oMyBar = dd.BarManager.Bars("MyBar") 
    oMyBar.UsedActionObjs.RemoveAll() 
CreateActionButton("MyButton_1","expl_star_yellow_aico","Starts User Command", "Call MsgBoxDisp(""User Function"")",oMyBar) 
oMyBar.UsedActionObjs.Add("Separator") 
CreateActionButton("MyButton_2","expl_star_yellow_delete.ico","Deletes Bar", "Call BarManager.Reset()",oMyBar) 
CreateActionPopupObj("MyPopup", "expl_star_yellow.ico", "Example-Bar", oMyBar, "SCRGroup") 
def CreateActionButton(sID, sIconName, sToolTip, sCommand, ByRef oBar): 
    sUniqueButton_ID = sID 
    if (dd.BarManager.ActionObjs.Exists(sUniqueButton_ID)) : 
        oButtonObj = dd.BarManager.ActionObjs(sUniqueButton_ID) 
    else: 
        oButtonObj = dd.BarManager.ActionObjs.Add(sUniqueButton_ID, "CustomButton") 
        oButtonObj.Picture = sIconName 
        oButtonObj.Tooltip = sToolTip 
        oButtonObj.OnClickCode.Code = sCommand 
    oBar.UsedActionObjs.Add(oButtonObj) 
def CreateActionPopupObj(sIDName, sIconName, sToolTip, oActionBar, sActionGroup): 
# New ActionObject
    sExampleMain_ID = sIDName 
    if (dd.BarManager.ActionObjs.Exists(sExampleMain_ID)) : 
        oExampleAction = dd.BarManager.ActionObjs(sExampleMain_ID) 
    else: 
        oExampleAction = dd.BarManager.ActionObjs.Add(sExampleMain_ID, "CustomPopup") 
        oExampleAction.Picture = sIconName 
        oExampleAction.Tooltip = sToolTip 
        oExampleAction.BarID = oActionBar.ID 
    if not dd.BarManager.Bars(sActionGroup).UsedActionObjs.Exists(oExampleAction) : 
        dd.BarManager.Bars(sActionGroup).UsedActionObjs.Add(oExampleAction) 
```

--------------------------------

### Call ApprAnsatzOff

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/comoff/appransatzoff.htm

Executes the command to clear all setup function terms for an approximation.

```DIAdem Script
Call ApprAnsatzOff()
```

--------------------------------

### Create and Configure PropertyValueMapping

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/scriptnavi/objects/navigator_objects_ivaluemapping.htm

Demonstrates creating a value mapper, adding a mapping for the 'name' property, and applying a regex-based replacement rule.

```VBScript
Dim oMyMapper, oMyChnNameMapping, oMyRule
Set oMyMapper = Navigator.Settings.CreateValueMapper()
Set oMyChnNameMapping = oMyMapper.Mappings(eSearchChannel).Add("name")
Set oMyRule = oMyChnNameMapping.Rules.Add(_
    "([[:alpha:]]+)([\_\-\/\\\?\ \:]+)([[:digit:]]+)","$1~text~$3","Example_1")
MsgBox "Pattern: " & oMyRule.Pattern & vBCrLf _
& "Scheme: " & oMyRule.Schema & vBCrLf _
& "Example to map: " & oMyRule.Example & vBCrLf _
& "Mapped example: " & oMyRule.MapProperty(oMyRule.Example)
```

```Python
oMyMapper = dd.Navigator.Settings.CreateValueMapper() 
oMyChnNameMapping = oMyMapper.Mappings(dd.eSearchChannel).Add("name") 
oMyRule = oMyChnNameMapping.Rules.Add("([[:alpha:]]+)([\_\-\/\\\\\?\ \:]+)([[:digit:]]+)","$1~text~$3","Example_1") 
print "Pattern: " + oMyRule.Pattern + "\r\n" + "Scheme: " + oMyRule.Schema + "\r\n" + "Example to map: " + oMyRule.Example + "\r\n" + "Mapped example: " + oMyRule.MapProperty(oMyRule.Example) 
```

--------------------------------

### Checking for Key Existence in a Dictionary

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/scripting/methods/scripting_method_exists_idictionary.htm

Example demonstrating the creation of a Dictionary, adding items, and verifying the existence of a specific key before adding a duplicate.

```VBScript
Dim MyDic
Set MyDic = CreateObject("Scripting.Dictionary")
Call MyDic.Add ("a", "Austin")
Call MyDic.Add ("b", "Berlin")
Call MyDic.Add ("c", "Chicago")
If MyDic.Exists("a") Then
  Call MsgBox("Key 'a' already exists")
Else
  Call MyDic.Add ("a", "Aachen")
End If
```

--------------------------------

### Extracting Characters with Right

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/methods/vbs_method_right_globalobj.htm

Example demonstrating how to retrieve the last three characters of the string 'DIAdem'.

```VBS
Dim MyString
MyString = Right("DIAdem", 3)
Call MsgBox(MyString) ' Returns "dem"
```

--------------------------------

### SUDDlgShow("Main", ResourceDrv & "AnaChnTransform")

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/dlgmaths/calc_basis_dlg/dlganachntransform_dialog.htm

Displays the Channel Transformation dialog in DIAdem.

```APIDOC
## SUDDlgShow("Main", ResourceDrv & "AnaChnTransform")

### Description
Displays the Channel Transformation dialog for performing coordinate system conversions.

### Method
Script Call

### Parameters
- **DialogName** (String) - Required - The name of the dialog to display ("Main").
- **DialogPath** (String) - Required - The path to the dialog resource.
```

--------------------------------

### SUDDlgShow("Main", ResourceDrv & "AnaChnNICBdryCalc")

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/comoff/chnnicbdrycalc.htm

Invokes the dialog box for the NIC boundary calculation.

```APIDOC
## Dialog Box Call

### Description
Calls the dialog box for the NIC boundary calculation.

### Syntax
SUDDlgShow("Main", ResourceDrv & "AnaChnNICBdryCalc")
```

--------------------------------

### ResetBarID Method Usage

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/tobarmanagerint/methods/diabars_method_resetbarid_toactionobjpopupint.htm

Examples demonstrating how to set and subsequently reset the BarID for a specific ActionObjPopup.

```VBScript
'Sets BarID
BarManager.ActionObjs("ANACrashAnalysis").BarID = "ANAMain"

'Resets BarID
Call BarManager.ActionObjs("ANACrashAnalysis").ResetBarID
```

```Python
#Sets BarID
BarManager.ActionObjs("ANACrashAnalysis").BarID = "ANAMain" 
#Resets BarID
dd.BarManager.ActionObjs("ANACrashAnalysis").Reset()BarID
```

--------------------------------

### Calculate Channel Exponentiation

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/functions/functions/potenz_1.htm

Examples of using the Calculate command to perform exponentiation on data channels.

```VBScript
Call Calculate ("Ch(""Group2/Result"")= 2 ^ Ch(""Group1/Input"")")
```

```Python
dd.Calculate ("Ch(""Group2/Result"")= 2 ^ Ch(""Group1/Input"")") 
```

--------------------------------

### SUDDlgShow("Main", ResourceDrv & "AnaMatChnConvert")

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/comoff/matchnconvert.htm

Invokes the Matrix Conversion dialog box within the DIAdem application.

```APIDOC
## SUDDlgShow("Main", ResourceDrv & "AnaMatChnConvert")

### Description
This command displays the Matrix Conversion dialog box, allowing users to perform matrix-to-channel conversion operations.

### Syntax
SUDDlgShow("Main", ResourceDrv & "AnaMatChnConvert")
```

--------------------------------

### Evaluate a User Command

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/functions/functions/scriptevaluate.htm

Examples of using ScriptEvaluate to retrieve the contents of a registered user command.

```VBScript
T1 = ScriptEvaluate("MyCommand(45.3)")    'T1 = Value: 45.3
```

```Python
T1 = dd.ScriptEvaluate("MyCommand(45.3)") #T1 = Value: 45.3
```

--------------------------------

### MQTT.Connect

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/diamisc/objects/mqtt_objects_mqtt.htm

Establishes a connection to the MQTT broker.

```APIDOC
## MQTT.Connect()

### Description
Initiates the connection to the MQTT broker configured for the MQTT object instance.
```

--------------------------------

### Check File Write-Protection

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/functions/functions/fileattrcheck_1.htm

Example demonstrating how to check if a report file is write-protected in VBScript and Python.

```VBScript
Dim blnMyResult
blnMyResult = FileAttrCheck(LayoutLibrPath & "Example.tdr","faReadOnly")
```

```Python
blnMyResult = dd.FileAttrCheck(dd.LayoutLibrPath + "Example.tdr","faReadOnly") 
```

--------------------------------

### Implement Context Menu in Tree Control

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/contextmenu/objects/contextmenu_objects_imenupoints.htm

Demonstrates initializing a tree structure and managing context menu interactions for specific nodes.

```VBScript
Sub Tree1_EventInitialize(ByRef This)
  Call CreateDefaultTree(This)
End Sub

Sub Tree1_EventContextMenuShowing(ByRef This, ByRef Node, MenuPoints)
  Call MenuPoints.Add("Menu 1",1)
  Call MenuPoints.Add("Menu 2",2)
End Sub

Sub Tree1_EventContextMenuPointSelected(ByRef This, ByRef Node, MenuPoint)
    Call MsgBox("Selected Node: " & Node.Text & VBCrLf & "Menu entry: " & MenuPoint.Text)
End Sub

Sub CreateDefaultTree(ByRef This)
  Dim oRoot, oMainNode
  Set oRoot = This.Nodes.Add("Tools")
  oRoot.Key = "tools"
  oRoot.Expanded = true
  Set oMainNode = oRoot.Nodes.Add("Electric Tools")
  oMainNode.Key = "electric"
  oMainNode.Nodes.Add("Drill").Key = "drill"
  oMainNode.Nodes.Add("Saw").Key = "saw"
  Set oMainNode = oRoot.Nodes.Add("Hand Tools")
  oMainNode.Key = "handtool"
  oMainNode.Nodes.Add("Hammer").Key = "hammer"
  oMainNode.Nodes.Add("Screwdriver").Key = "screwdriver"
  oMainNode.Nodes.Add("Tongs").Key = "tongs"
End Sub
```

--------------------------------

### Determine Variable Subtype

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/methods/vbs_method_vartype_globalobj.htm

Example demonstrating how to check the subtype of a variable using a Select Case statement.

```VBS
Dim MyVar
MyVar = Array(1,2,3,4)
Select Case VarType(MyVar) 
Case VBEmpty
  Call MsgBox("Empty")
Case VBNull
  Call MsgBox("Null")
Case VBInteger
  Call MsgBox("Integer")
Case vbLong
  Call MsgBox("Long")
Case vbSingle
  Call MsgBox("Single")
Case vbDouble
  Call MsgBox("Double")
Case vbCurrency
  Call MsgBox("Currency")
Case vbDate
  Call MsgBox("Date")
Case vbString
  Call MsgBox("String")
Case vbObject
  Call MsgBox("Object")
Case vbError
  Call MsgBox("Error")
Case vbBoolean
  Call MsgBox("Boolean")
Case vbDataObject
  Call MsgBox("DataObject")
Case vbByte
  Call MsgBox("Byte")
Case vbArray + vbVariant  
  Call MsgBox("Variant Array")
End Select
```

--------------------------------

### Create a 1:1 Property Value Mapping

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/scriptnavi/objects/navigator_objects_ivaluerules.htm

Demonstrates creating a value mapper and adding a 1:1 replacement rule for a channel name property.

```VBScript
Dim oMyMapper, oMyChnNameMapping, oMyPair
Set oMyMapper = Navigator.Settings.CreateValueMapper()
Set oMyChnNameMapping = oMyMapper.Mappings(eSearchChannel).Add("name")
Set oMyPair = oMyChnNameMapping.Rules.AddPair("Example_1", "Example~1")
Call MsgBoxDisp ("Mapped Example: " & oMyPair.MapProperty("Example_1")) 'Mapped Example: Example~1
```

```Python
oMyMapper = dd.Navigator.Settings.CreateValueMapper() 
oMyChnNameMapping = oMyMapper.Mappings(dd.eSearchChannel).Add("name") 
oMyPair = oMyChnNameMapping.Rules.AddPair("Example_1", "Example~1") 
dd.MsgBoxDisp ("Mapped Example 
" + oMyPair.MapProperty("Example_1")) 'Mapped Example: Example~1 
```

--------------------------------

### Searching Text with InStr

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/methods/vbs_method_instr_globalobj.htm

Examples demonstrating how to search for character strings using different comparison modes.

```VBS
Dim MyPos
MyPos = InStr("abcdabcde", "c")                   'Returns 3
Call MsgBox(MyPos) 
MyPos = InStr("abcdabcde", "C")                   'Returns 0
Call MsgBox(MyPos) 
MyPos = InStr(1, "abcdabcde", "C", vbTextCompare) 'Returns 3
Call MsgBox(MyPos)
```

--------------------------------

### Converting Text to Long Value

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/methods/vbs_method_clng_globalobj.htm

Example demonstrating the conversion of a Double value to a Long using CLng.

```VBS
Dim MyDouble
MyDouble = 54321.5678         ' Defines a Double
Call MsgBox(CLng(MyDouble))   ' Returns 54321
```

--------------------------------

### Executing a Search with DataFinderDisplay

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/scriptnavi/objects/navigator_objects_idatafinderdisplay.htm

This example demonstrates how to configure an advanced search using the DataFinderDisplay object, execute the search, and load the results into the Data Portal.

```APIDOC
## DataFinderDisplay Search Execution

### Description
This method demonstrates how to access the current DataFinder, configure search conditions using the QueryForm, execute the search, and retrieve the results.

### Usage
1. Access the current DataFinder via `Navigator.Display.CurrDataFinder`.
2. Configure the `QueryForm` (Mode, ReturnType, and Conditions).
3. Call `Search()` to execute the query.
4. Access results via `ResultsList.ResultsElements`.

### Example (VBScript)
```vbscript
Dim oMyCurrDataProvider, oMyQueryForm, oMyConditions, oMyResults
Set oMyCurrDataProvider = Navigator.Display.CurrDataFinder
Set oMyQueryForm = oMyCurrDataProvider.QueryForm
Call oMyQueryForm.Clear
oMyQueryForm.Mode = eAdvancedQueryForm
oMyQueryForm.ReturnType = eSearchChannel
Set oMyConditions = oMyQueryForm.Conditions
'Setting query conditions
Call oMyConditions.Add(eSearchFile,"fileName","=","TR_M17_QT_*")
Call oMyConditions.Add(eSearchChannelGroup,"Test_Status","=","fail")
'Searching
Call oMyQueryForm.Search()
Set oMyResults = oMyCurrDataProvider.ResultsList.ResultsElements
'Loading results into Data Portal
Call Navigator.LoadData(oMyResults)
```
```

--------------------------------

### CreateObject("Scripting.FileSystemObject")

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/scripting/objects/scripting_objects_ifilesystem3.htm

Initializes the FileSystemObject to enable file system access within DIAdem scripts.

```APIDOC
## CreateObject("Scripting.FileSystemObject")

### Description
Creates an instance of the FileSystemObject to allow interaction with the local file system.

### Usage
Set fso = CreateObject("Scripting.FileSystemObject")

### Example
```vbscript
Dim fso, MyFile
Set fso = CreateObject("Scripting.FileSystemObject")
Set MyFile = fso.CreateTextFile(ScriptWritePath & "\testfile.txt", True)
MyFile.WriteLine("This is the first line")
MyFile.Close
```
```

--------------------------------

### Displaying Characters with ChrB

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/methods/vbs_method_chrb_globalobj.htm

Example showing how to use ChrB to display characters for specific ANSI codes.

```vbs
Call MsgBox (ChrB(65)) ' Returns A
Call MsgBox (ChrB(97)) ' Returns a
```

--------------------------------

### Mapping.Rules.Add(Pattern, Schema, Example)

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/scriptnavi/objects/navigator_objects_ivaluemapper.htm

Adds a new rule to a property mapping to define how values are transformed.

```APIDOC
## Mapping.Rules.Add(Pattern, Schema, Example)

### Description
Adds a transformation rule to a mapping, defining a search pattern and a replacement schema.

### Parameters
- **Pattern** (String) - The regular expression pattern to search for.
- **Schema** (String) - The replacement pattern string.
- **Example** (String) - An example text used to validate the mapping rule.
```

--------------------------------

### Select and save file using FileNameGet

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/comoff/filenameget.htm

Demonstrates the logic for selecting a file path via dialog and performing conditional save operations based on file existence and user input.

```VBScript
If (FileNameGet ("NAVIGATOR", "FileWrite", DataReadPath & Data.Root.Properties("name").Value & "." & DataExtension) = "IDOk") Then 
  If FilEx(FileDlgFileName) Then  'File exists
    Call MsgBoxDisp("File " & FileDlgFileName & " exists. Overwrite?","MB_YESNO")
    If  (MsgState = "IDYes") Then 
        If (FileDlgPartial= TRUE) Then 'Use selected channels
          Call DataFileSaveSel(FileDlgFileName, FileDlgFilter, Portal.ActiveView.Selection)
        Else
          Call DataFileSave(FileDlgFileName, FileDlgFilter )
        End If
    Else 'Dialog was canceled
      Call MsgBoxDisp ("Data saving was canceled")
    End If 
  Else   'File does not exist
    If (FileDlgPartial= TRUE) Then 'Use selected channels
      Call DataFileSaveSel(FileDlgFileName, FileDlgFilter, Portal.ActiveView.Selection)
    Else
      Call DataFileSave(FileDlgFileName, FileDlgFilter )
    End If
  End If 
Else 'Dialog was canceled
  Call MsgBoxDisp ("Data saving was canceled")
End If
```

```Python
if (dd.FileNameGet ("dd.NAVIGATOR", "dd.FileWrite", dd.DataReadPath + dd.Data.Root.Properties("name").Value + "." + dd.DataExtension) == "IDOk"): 
    if dd.FilEx(dd.FileDlgFileName): #File exists
        dd.MsgBoxDisp("File " + dd.FileDlgFileName + " exists. Overwrite?","MBYESNO") 
        if (dd.MsgState == "IDYes"): 
            if (dd.FileDlgPartial== True): #Use selected channels
                dd.DataFileSaveSel(dd.FileDlgFileName, dd.FileDlgFilter, dd.Portal.ActiveView.Selection) 
            else: 
                dd.DataFileSave(dd.FileDlgFileName, dd.FileDlgFilter ) 
        else: #Dialog was canceled
            dd.MsgBoxDisp ("dd.Data saving was canceled") 
    else: #File does not exist
        if (dd.FileDlgPartial== True): #Use selected channels
            dd.DataFileSaveSel(dd.FileDlgFileName, dd.FileDlgFilter, dd.Portal.ActiveView.Selection) 
        else: 
            dd.DataFileSave(dd.FileDlgFileName, dd.FileDlgFilter ) 
else: #Dialog was canceled
    dd.MsgBoxDisp ("dd.Data saving was canceled")
```

--------------------------------

### Refresh DataFinder Browser View

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/scriptnavi/methods/navigator_method_refreshall_inavidatafinderbrowser.htm

Examples of refreshing the file browser view using VBScript and Python.

```VBScript
Call Navigator.Display.CurrDataFinder.Browser.RefreshAll()
```

```Python
dd.Navigator.Display.CurrDataFinder.Browser.RefreshAll() 
```

--------------------------------

### SUDDlgShow("Main", ResourceDrv & "AnaChnWrapUnwrap")

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/comoff/chnphasewrap.htm

Invokes the Phase Unwrap/Wrap dialog box.

```APIDOC
## SUDDlgShow("Main", ResourceDrv & "AnaChnWrapUnwrap")

### Description
This command displays the Phase Unwrap/Wrap dialog box in the DIAdem interface.

### Usage
Call SUDDlgShow("Main", ResourceDrv & "AnaChnWrapUnwrap")
```

--------------------------------

### SUDDlgShow("Main", ResourceDrv & "AnaMatAppend")

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/comoff/matappend.htm

Invokes the MatAppend dialog box to perform matrix appending operations.

```APIDOC
## SUDDlgShow("Main", ResourceDrv & "AnaMatAppend")

### Description
This command displays the MatAppend dialog box, which allows users to append matrices in the DIAdem environment.

### Syntax
SUDDlgShow("Main", ResourceDrv & "AnaMatAppend")
```

--------------------------------

### Define Approximation Function Terms

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/varoff/appransatzfct.htm

These script terms represent the available function options for the approximation setup.

```text
"-"
```

```text
"Yes"
```

--------------------------------

### SUDDlgShow("Main", ResourceDrv & "AnaChnAccelWCalc")

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/comoff/chnaccelwcalc.htm

Invokes the Frequency-Weighted Acceleration dialog box.

```APIDOC
## SUDDlgShow

### Description
Invokes the Frequency-Weighted Acceleration dialog box within the DIAdem application.

### Syntax
SUDDlgShow("Main", ResourceDrv & "AnaChnAccelWCalc")

### Parameters
- **DialogName** (String) - The name of the dialog to show, specified as "Main".
- **ResourcePath** (String) - The path to the dialog resource, constructed using the ResourceDrv variable and the identifier "AnaChnAccelWCalc".
```

--------------------------------

### Displaying the day of the week

Source: https://www.ni.com/docs/en-US/bundle/diadem/page/vbs/properties/vbs_property_vbusesystemdayofweek_globalobj.htm

Example demonstrating how to use vbUseSystemDayOfWeek with the Weekday function to retrieve the current day of the week.

```VBS
Dim iMyDayOfWeek
iMyDayOfWeek = Weekday(Now, vbUseSystemDayOfWeek)
Call MsgBox ("Day of week: " & iMyDayOfWeek)
```
Tokens:
Raw