Search Result Field Constants
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
10/16/2008
The following constants are used to indicate fields that are requested for a search result:
| Constant | Value | Description |
|---|---|---|
MINIMUM_SEARCH_RESULT_FIELDS |
0x0000 |
Represents the minimum set of fields for a search result. |
ADDRESSLINE_SEARCH_RESULT_FIELD |
0x0001 |
Represents the minimum set of fields, plus the address field, for a search result. |
CITY_SEARCH_RESULT_FIELD |
0x0002 |
Represents the minimum set of fields, plus the city field, for a search result. |
PROVINCE_SEARCH_RESULT_FIELD |
0x0004 |
Represents the minimum set of fields, plus the province field, for a search result. |
POSTALCODE_SEARCH_RESULT_FIELD |
0x0008 |
Represents the minimum set of fields, plus the postal-code field, for a search result. Do not use. The postal code field must not be exposed in the initial search results list. |
COUNTRYCODE_SEARCH_RESULT_FIELD |
0x0010 |
Represents the minimum set of fields, plus the country/region code field, for a search result. |
PHONENUMBER_SEARCH_RESULT_FIELD |
0x0020 |
Represents the minimum set of fields, plus the phone-number field, for a search result. |
ROOFTOPLOCATION_SEARCH_RESULT_FIELD |
0x0040 |
Represents the minimum set of fields, plus the rooftop-location field, for a search result. |
EMAIL_SEARCH_RESULT_FIELD |
0x0080 |
Represents the minimum set of fields, plus the e-mail address field, for a search result. |
FAXNUMBER_SEARCH_RESULT_FIELD |
0x0100 |
Represents the minimum set of fields, plus the fax-number field, for a search result. |
TOLLFREENUMBER_SEARCH_RESULT_FIELD |
0x0200 |
Represents the minimum set of fields, plus the toll-free number field, for a search result. |
WEBSITE_SEARCH_RESULT_FIELD |
0x0400 |
Represents the minimum set of fields, plus the Web-site address field, for a search result. |
HOURSOFOPERATION_SEARCH_RESULT_FIELD |
0x0800 |
Represents the minimum set of fields, plus the hours-of-operation field, for a search result. |
PAYMENTOPTIONS_SEARCH_RESULT_FIELD |
0x1000 |
Represents the minimum set of fields, plus the payment-options field, for a search result. |
CATEGORIES_SEARCH_RESULT_FIELD |
0x2000 |
Represents the minimum set of fields, plus the categories field, for a search result. |
RATING_SEARCH_RESULT_FIELD |
0x4000 |
Represents the ratings field, which exposes a numeric user-rated value for the POI. |
Remarks
To display detailed information about each search result, an application must specify the search-result fields that it wants to populate with returned data when it creates a PhoneBookSearchRequest structure.
The MINIMUM_SEARCH_RESULT_FIELDS constant includes the minimum set of fields in a search result, which includes the phone-book ID field, the name field, the curbside-location field, and the search-result type field.
Curbside locations are useful for driving directions, whereas rooftop locations are useful for putting a pin on top of a Point of Interest (POI) on a map; for example, at the middle of a building.
Make sure that the user interface for your local-search application provides elements to display the information in supported search-result fields.
The value returned in the ratings field can range from 0 to 10 and can have at most one decimal digit. The application developer can map this to a value that you want to display together with the search result. For example, if you want to use a rating scale of 0 to 5 and the ratings value returned is 9.1, you can round it to the nearest integer value (9) and then divide by 2, which results in 4.5. Then, you can display this value to the user. For example:
.jpg "POI Ratings field")
Requirements
| Header | localsearch.h |
| Library | localsearch.lib |
| Windows Embedded CE | Windows CE 5.0, Windows Embedded NavReady 2009 |