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.

CodeSonar® 9.2p0 CONFIDENTIAL CodeSecure Inc
General

GUI Reference: Code Search Results

Displays the results of code searches.

A code search can be performed for any analysis, but code search results will only include token occurrences in 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.

Navigating to

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

From Advanced Search: Issue a search in the Code tab (only available if there is a focal analysis).
From Analysis (any tab): Issue a search using the simple search tool.
From a Chart or Chart Table: Issue a search using the simple search tool (code option only available if there is a focal analysis).
From any Log: Issue a search using the simple search tool.
From Saved Searches: Click on a line in the Code tab.
From Source Listing: Issue a search using the simple search tool.

Page Properties

Output formats CSV, JSON, XML (code_search.xsd)
Visibility Filter Applied Visible Code
RBAC Permissions Needed
Page AccessANALYSIS_READ
PROJECT_READ
Page Contents/FunctionalityNAMEDSEARCH_WRITE
For more information, see Searching: Permissions.

Contents and Usage

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

Annotated Screenshot: Analysis Page standard header breadcrumbs heading Save link Other Domains suggestions result table standard footer

Standard Header See GUI Reference: Standard Header.
Breadcrumbs Home > [Other_ProjectTree_Ancestors >] Project_Name > Analysis_Name > Code 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 project analyzed by this analysis, 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 : Code
Save link Expands to provide functionality for saving the current search. See Save a Search for full details.

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

  • The Code tab of the Advanced Search page provides a list of saved code searches: select a search from this list to execute it in an appropriate scope (where possible: see Searching: Saved Search Execution Scope: Code ).
  • The Code tab of the Saved Searches page provides information about the current set of saved code searches, and provides deletion functionality. Click a row in the table of searches to execute the corresponding search in in an appropriate scope (where possible: see Searching: Saved Search Execution Scope: Code ).
  • The Visible Code 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 Code 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 occurrence tuples that match the search conditions.

The results 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 Name Cross-References: Availability.

Standard Footer See GUI Reference: Standard Footer.

Saving a Search

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

To save a search:

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

    Annotated Screenshot Fragment: Save This Search link, with expansions

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

Navigating from

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

To report problems with this documentation, please visit https://support.codesecure.com/.