|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
|
2 <html> |
|
3 <head> |
|
4 <meta http-equiv="content-type" content="text/html; charset=iso-8859-1"> |
|
5 <title>Running an API query from the Search tab </title> |
|
6 <link href="../../book.css" type="text/css" rel="stylesheet"> |
|
7 </head> |
|
8 <body> |
|
9 |
|
10 <h2>Running an API query from the Search tab</h2> |
|
11 |
|
12 <h5>Before you start</h5> |
|
13 <p>Make sure you have configured the data source you want to use. For instructions, see <a href="../tasks/configure_data_sources.htm">Configuring data sources</a>.</p> |
|
14 <p>To run API queries, do the following:</p> |
|
15 <ol> |
|
16 <li>Select the query type from the <b>Query by</b> group.<p><b>Note:</b> a different set of query types may be enabled depending on the configured data source. </p></li> |
|
17 <li>In the <b>Search string</b> field, enter the string you want to search for. <p>For example, <code>avkon</code> for an API name or <code>akna</code> for a header name, and so on. For multi search seperate the keyword with "; " character. Wildcard characters (*,?) are not supported.</p></li> |
|
18 <li>To run the query, click <b>Search</b>.<p>The list of found APIs are shown in the <b>Search results</b> list, as shown in the example below.</p> |
|
19 <p><b>Single keyword search </b></p> |
|
20 <img src="screenshots/singlesearch.PNG"> |
|
21 <p><b>Multi Keyword search</b></p> |
|
22 <img src="screenshots/multiserach.png"> |
|
23 |
|
24 <p>The ID of the data source is shown in the brackets after the API name. If there are multiple data source entries configured, the same API may be listed once for each data source entry.</p> |
|
25 <p>To view only the API names in the <b>Search results</b> list, check the option <b>Show only API names</b>.</p></li> |
|
26 <li>Select the API of your choice from the list to view its details. <p>The information is fetched into the <b>API details</b> table and the value that fulfils the search criteria is highlighted with red, as shown in the example below.</p> |
|
27 <p><img src="screenshots/results.png"></p> |
|
28 <p>Headers can be opened by clicking on the link provided in the api details tab.Header is opened in editor/web browser based on the selected data source.If the data source is sdk then it will be opened in editor.If the data source is webserver then it will be opened in s60lxr.</p> |
|
29 <p>Note: the data fields shown in the <b>API details</b> table can vary based on the current data source selection and headerlink will be enabled only when the serach is for header file.</p> |
|
30 </li> |
|
31 </ol> |
|
32 |
|
33 <h5>Related tasks</h5> |
|
34 <ul> |
|
35 <li><a href="../tasks/configure_data_sources.htm">Configuring data sources</a></li> |
|
36 <li><a href="../tasks/query_from_context_menu.htm">Running an API query from the context menu</a></li> |
|
37 </ul> |
|
38 |
|
39 <div id="footer">Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. |
|
40 License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>.</div> |
|
41 </body> |
|
42 </html> |
|
43 |