Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add DIS Parameter Update Locations tool window docs #4342

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions develop/TOOLS/DIS/ToolWindows/DisParameterUpdateLocations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
uid: DisParameterUpdateLocationsToolWindow
---

# DIS Parameter Update Locations

Starting from DIS 3.1.6, you can use the *DIS Parameter Update Locations* tool window to check from which locations parameters get updated.

To do so, select *Tool Windows* > *DIS Parameter Update Locations*, and then select a parameter in the dropdown. The *Confirmed Update locations* pane will then show the locations from which this parameter gets updated.

For example, if the pane lists an Action, this means that the action, when executed, performs a set on this parameter. When a QAction is listed, it means that the QAction invokes a method (the line number is mentioned in the result window) that results in the update of the parameter.

The *Confirmed Update locations* will also mark an update location in red in case an update location is wrong, for example in case a method is called that should be executed on a table parameter but is executed on a standalone parameter.

The *Possible Update locations* gives an overview of possible locations where this parameter **might** be updated. This could for example be a QAction that contains a `protocol.SetParameter()` call, in case DIS cannot determine which parameter gets updated. This is for example the case when the ID of the parameter that is set is calculated at runtime.

To trigger a recalculation of the update locations, use the *Refresh* button above the parameter dropdown at the top of the window.

![DIS Parameter update locations tool window](~/develop/images/DisParameterUpdateLocationsToolWindow.png)

> [!TIP]
> This window can also be opened via the parameter dropdown menu in the protocol.xml.

> [!NOTE]
> The following update locations are currently not recognized by DIS:
>
> - HTTP Sessions. These are not yet supported.
> - The actions Aggregate, Merge, Normalize, ReadFile, Set, SetAndGetWithWait, SetWithWait, SwapColumn, and Wmi.
> - In SLProtocolExt, the generated parameter property setters.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions develop/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5550,6 +5550,8 @@ items:
topicUid: DisInjectToolWindow
- name: DIS MIB Browser
topicUid: DisMibBrowserToolWindow
- name: DIS Parameter Update Locations
topicUid: DisParameterUpdateLocationsToolWindow
- name: Plugins
topicUid: DisPlugins
- name: Development using DIS
Expand Down