Running an API query for a project

You can generate a report of the usage of APIs throughout your active project from the context menu. You can access the context menu either by right-clicking any .cpp or .h file or any folder in the C/C++ Projects view, or by right-clicking your code anywhere in the editor.

The report is a table in HTML format and is named as [name]-project_is_using_APIs.html by default. You can view it in Carbide's internal browser or in any Web browser.

To run a query for a project, do the following:

  1. Right-click the item of your choice and from the pop-up menu, select API Query > for Active Project.
  2. In the Save As dialog, select the location for saving the query report within your project and click OK.
  3. When the report has been generated, click OK in the confirmation dialog to view it right away.

    The report is opened to Carbide's internal browser. See the following figure for an example:

    You can perform operations by clicking the underlined links in the report:

    Note: You can only open links from the report when the API Query Carbide.c++ Extension is running.

Related tasks