GUI: Procedure Search Results

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

GUI Reference: Procedure Search Results

Displays the results of procedure searches.

A procedure search can be performed for any analysis, but procedure search results will only include procedures from analyzed C/C++, C#, and Java code.

For the results of searches in other domains, see Search Results.

Important Note: the CodeSonar Web GUI makes extensive use of JavaScript. Make sure JavaScript is enabled in your web browser.

The Procedure Search Results page can be reached in any of the following ways.

From Advanced Search:	Issue a search in the Procedures tab (only available if there is a focal analysis).
From Analysis Procedures:	Issue a search using the simple search tool.
From Saved Searches:	Click on a line in the Procedures tab.

From Advanced Search:

Issue a search in the Procedures tab (only available if there is a focal analysis).

From Analysis Procedures:

Issue a search using the simple search tool.

From Saved Searches:

Click on a line in the Procedures tab.

Page Access

ANALYSIS_READ
PROJECT_READ

Page Contents/Functionality

NAMEDSEARCH_WRITE

The following annotated screenshot shows the various parts of a Procedure Search Results page.

Annotated Screenshot: Procedure Search Results Page

Standard Header	See GUI Reference: Standard Header.
Breadcrumbs	*Home > [Other_ProjectTree_Ancestors* >] Project_Name > Analysis_Name > Procedure Search Results** where Home links to the GUI Home page. Together with the Home link (corresponding to the root project tree), Other_ProjectTree_Ancestors represents the project tree ancestors of the analyzed project as a >-separated sequence of project tree names. Each name links to the corresponding Project Tree page. Project_Name is the name of the analyzed project, and links to the corresponding Project page. Analysis_Name is the value of the Analysis property for this analysis, and links to the corresponding Analysis page.
Page Heading	Project_Name : Analysis_Name : Search Results : Procedures
Save link	Expands to provide functionality for saving the current search. See Save a Search for full details. Saved procedure searches are available (subject to NAMEDSEARCH_EXISTS permissions) in several GUI locations: The Procedures tab of the Advanced Search page provides a list of saved procedure searches: select a search from this list to execute it in an appropriate scope (where possible: see Searching: Saved Search Execution Scope: Procedures). The Procedures tab of the Saved Searches page provides information about the current set of saved procedure searches, and provides deletion functionality. Click a row in the table of searches to execute the corresponding search in an appropriate scope (where possible: see Searching: Saved Search Execution Scope: Procedures). The Visible Procedures selector provides a list of saved procedure searches: select a search from this list to impose the corresponding constraints on the page contents. The effect of the Visible Procedures selection is independent of the original scope of the search.
'Other Domains' suggestions	Shortcut links to execute the same query in different domains. One link is provided to for every domain to which the search query is applicable. If the search is not applicable to any other domains, this section is not included.
Table of results	A table describing all procedures that match the search conditions. The procedures and properties listed in the table are (usually) from the most recent analysis of the project: CodeSonar will display a notification message at the top of the table if the information is from an analysis other than the one originally specified as the search scope. For further information, see Procedures: Availability. The table has the standard pagination controls. Click on any line in the table to navigate to the corresponding procedure definition inside a Source Listing page. The available table columns are as follows. Columns displayed by default are marked with an asterisk (). File (Procedure File . File) Procedure * File Path (Procedure File . File Path) Directory (Procedure File . Directory) Line Number (Procedure Line) Language (Procedure File . Language) Every built-in and user-defined procedure-granularity metric class present in at least one analysis that has taken place on the hub (subject to ANALYSIS_READ permission), each labeled with the metric class description. Lines With Code (LCode) and Cyclomatic Complexity (vG) are displayed by default.
Standard Footer	See GUI Reference: Standard Footer.

Standard Header

See GUI Reference: Standard Header.

Breadcrumbs

Home > [Other_ProjectTree_Ancestors >] Project_Name > Analysis_Name > Procedure Search Results
where

Home links to the GUI Home page.
Together with the Home link (corresponding to the root project tree), Other_ProjectTree_Ancestors represents the project tree ancestors of the analyzed project as a >-separated sequence of project tree names. Each name links to the corresponding Project Tree page.
Project_Name is the name of the analyzed project, and links to the corresponding Project page.
Analysis_Name is the value of the Analysis property for this analysis, and links to the corresponding Analysis page.

Page Heading

Project_Name : Analysis_Name : Search Results : Procedures

Save link

Expands to provide functionality for saving the current search. See Save a Search for full details.

Saved procedure searches are available (subject to NAMEDSEARCH_EXISTS permissions) in several GUI locations:

The Procedures tab of the Advanced Search page provides a list of saved procedure searches: select a search from this list to execute it in an appropriate scope (where possible: see Searching: Saved Search Execution Scope: Procedures).
The Procedures tab of the Saved Searches page provides information about the current set of saved procedure searches, and provides deletion functionality. Click a row in the table of searches to execute the corresponding search in an appropriate scope (where possible: see Searching: Saved Search Execution Scope: Procedures).
The Visible Procedures selector provides a list of saved procedure searches: select a search from this list to impose the corresponding constraints on the page contents. The effect of the Visible Procedures selection is independent of the original scope of the search.

'Other Domains' suggestions

Shortcut links to execute the same query in different domains.

One link is provided to for every domain to which the search query is applicable.
If the search is not applicable to any other domains, this section is not included.

Table of results

A table describing all procedures that match the search conditions.

The procedures and properties listed in the table are (usually) from the most recent analysis of the project: CodeSonar will display a notification message at the top of the table if the information is from an analysis other than the one originally specified as the search scope. For further information, see Procedures: Availability.

The table has the standard pagination controls.
Click on any line in the table to navigate to the corresponding procedure definition inside a Source Listing page.
The available table columns are as follows. Columns displayed by default are marked with an asterisk (*).
- File * (Procedure File . File)
- Procedure *
- File Path (Procedure File . File Path)
- Directory (Procedure File . Directory)
- Line Number (Procedure Line)
- Language (Procedure File . Language)
- Every built-in and user-defined procedure-granularity metric class present in at least one analysis that has taken place on the hub (subject to ANALYSIS_READ permission), each labeled with the metric class description. Lines With Code (LCode) and Cyclomatic Complexity (vG) are displayed by default.

Standard Footer

See GUI Reference: Standard Footer.

See Searching: Saved Searches: Permissions for details of the permissions required to save a named search.

To save a search:

Click to open the Save form, as in the example below.

Annotated Screenshot Fragment: Save This Search link, with expansions

To save the search, enter a name in the text box and click Save.

If you want to replace an existing search with the same name, select overwrite.
To close the Save form without saving a search, click Cancel.

view a procedure definition in a source listing	Click the Procedure name in a result table entry. The source listing will be scrolled to the corresponding procedure definition when it opens.

view a procedure definition in a source listing

Click the Procedure name in a result table entry. The source listing will be scrolled to the corresponding procedure definition when it opens.

GUI Reference: Procedure Search Results

Navigating to

Page Properties

Contents and Usage

Saving a Search

Navigating from