RequestResultBase.ResultCode Property

Returns the code that contains information on whether the last request was successful.

Namespace: DevExpress.Xpf.Map

Assembly: DevExpress.Xpf.Map.v24.2.dll

NuGet Package: DevExpress.Wpf.Map

Declaration

C#

public RequestResultCode ResultCode { get; }

VB.NET

Public ReadOnly Property ResultCode As RequestResultCode

Property Value

Type	Description
RequestResultCode	A RequestResultCode enumeration value.

Available values:

Name	Description
Success	The request was successful.
BadRequest	The request was incorrect.
ServerError	The request was unsuccessful because of a server error.
Timeout	The request was terminated because the time was out.

Example

This example demonstrates how to manually process received Bing Search request results.

Important

On May 21, 2024, Microsoft announced that Bing Maps for Enterprise and its API will be discontinued. Azure Maps will be a single unified enterprise mapping platform available from Microsoft.

We are working on API compatible with Azure Maps and expect to ship it with our next major release (v24.2).

If you have an existing license to Bing Maps for Enterprise, you can continue using our existing API. You need to transition to new API until June 30, 2025 (free and basic license) or until June 30, 2028 (enterprise license).

The last date you can get a new license to Bing Maps for Enterprise is June 30, 2025. If you do not have an existing license after that date, you would not be able to use our map controls with Bing Maps or Azure Maps (until we release the new API). During that time, you can use other map providers supported by our controls, such as OpenStreetMap.

• Create a InformationLayer object and add it to the MapControl.Layers collection. Assign the BingSearchDataProvider object to the InformationLayer.DataProvider property.
• Handle the BingSearchDataProvider.SearchCompleted event. In the event handler, implement the request result processing.

Note

If you run the application, and see a window with the following error message: ”The specified Bing Maps key is invalid. To create a developer account, refer to https://www.microsoft.com/en-us/maps/create-a-bing-maps-key”, refer to the following tutorial: How to: Get a Bing Maps Key.

View Example

MainWindow.xaml.vb

Private Sub searchProvider_SearchCompleted(ByVal sender As Object, ByVal e As BingSearchCompletedEventArgs)
    If e.Cancelled Then
        Return
    End If
    If e.RequestResult.ResultCode <> RequestResultCode.Success Then
        Return
    End If

    Dim sb As New StringBuilder()

    Dim requestResult As SearchRequestResult = e.RequestResult
    sb.Append(String.Format("Result Code: {0}" & vbLf, requestResult.ResultCode))
    If String.IsNullOrEmpty(requestResult.FaultReason) Then
        sb.Append(String.Format("Fault Reason: (none)" & vbLf, requestResult.FaultReason))
    Else
        sb.Append(String.Format("Fault Reason: {0}" & vbLf, requestResult.FaultReason))
    End If
    sb.Append(String.Format("Search Location: {0}" & vbLf, requestResult.Keyword))
    sb.Append(String.Format("Estimated Matches: {0}" & vbLf, requestResult.EstimatedMatches))
    sb.Append(String.Format("SearchResults:" & vbLf & "{0}", ProcessLocationList(requestResult.SearchResults)))

    tbSearchResult.Text = sb.ToString()

End Sub

Private Function ProcessLocationList(ByVal results As List(Of LocationInformation)) As String
    If results Is Nothing Then
        Return ""
    End If

    Dim sb As New StringBuilder()
    For i As Integer = 0 To results.Count - 1
        sb.Append(String.Format("{0}) {1}", i + 1, ProcessLocationInformation(results(i))))
    Next i
    Return sb.ToString()
End Function
Private Function ProcessLocationInformation(ByVal info As LocationInformation) As String
    If info Is Nothing Then
        Return ""
    End If

    Dim sb As New StringBuilder()

    sb.Append(String.Format("{0}" & vbLf, info.DisplayName))
    sb.Append(String.Format(vbTab & "Adress: {0}" & vbLf, info.Address))
    sb.Append(String.Format(vbTab & "Location: {0}" & vbLf, info.Location))
    Return sb.ToString()
End Function

MainWindow.xaml.cs

private void searchProvider_SearchCompleted(object sender, BingSearchCompletedEventArgs e) {
    if (e.Cancelled) return;
    if (e.RequestResult.ResultCode != RequestResultCode.Success) return;

    StringBuilder sb = new StringBuilder();

    SearchRequestResult requestResult = e.RequestResult;
    sb.Append(String.Format("Result Code: {0}\n", requestResult.ResultCode));
    if (String.IsNullOrEmpty(requestResult.FaultReason))
        sb.Append(String.Format("Fault Reason: (none)\n", requestResult.FaultReason));
    else
        sb.Append(String.Format("Fault Reason: {0}\n", requestResult.FaultReason));
    sb.Append(String.Format("Search Location: {0}\n", requestResult.Keyword));
    sb.Append(String.Format("Estimated Matches: {0}\n", requestResult.EstimatedMatches));
    sb.Append(String.Format("SearchResults:\n{0}", ProcessLocationList(requestResult.SearchResults)));

    tbSearchResult.Text = sb.ToString();

}

string ProcessLocationList(List<LocationInformation> results) {
    if (results == null) return "";

    StringBuilder sb = new StringBuilder();
    for (int i = 0; i < results.Count; i++) {
        sb.Append(String.Format("{0}) {1}", i + 1, ProcessLocationInformation(results[i])));
    }
    return sb.ToString();
}
string ProcessLocationInformation(LocationInformation info) {
    if (info == null) return "";

    StringBuilder sb = new StringBuilder();

    sb.Append(String.Format("{0}\n", info.DisplayName));
    sb.Append(String.Format("\tAdress: {0}\n", info.Address));
    sb.Append(String.Format("\tLocation: {0}\n", info.Location));
    return sb.ToString();
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ResultCode property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

wpf-map-process-search-with-a-custom-search-panel/CS/MapControl_SearchPanel/MainWindow.xaml.cs#L29

if (e.Cancelled) return;
if (e.RequestResult.ResultCode != RequestResultCode.Success) return;

wpf-map-programmatically-search-with-the-bing-map-search-service/CS/DXMapExample/MainWindow.xaml.cs#L21

if(e.Cancelled) return;
if(e.RequestResult.ResultCode != RequestResultCode.Success) {
    teResult.Text = "The Bing Search service does not work for this location.";

wpf-map-get-routes-to-the-destination-point-with-the-bing-map-route-data-service/CS/CalculateRoutesFromMajorRoads/MainWindow.xaml.cs#L22

StringBuilder resultList = new StringBuilder();
resultList.Append(String.Format("Status: {0}\n", result.ResultCode));
resultList.Append(String.Format("Fault reason: {0}\n", result.FaultReason));

VB.NET

wpf-map-process-search-with-a-custom-search-panel/VB/MapControl_SearchPanel/MainWindow.xaml.vb#L31

If e.Cancelled Then Return
If e.RequestResult.ResultCode <> RequestResultCode.Success Then Return
Dim sb As StringBuilder = New StringBuilder()

wpf-map-programmatically-search-with-the-bing-map-search-service/VB/DXMapExample/MainWindow.xaml.vb#L23

If e.Cancelled Then Return
If e.RequestResult.ResultCode <> RequestResultCode.Success Then
    Me.teResult.Text = "The Bing Search service does not work for this location."

wpf-map-get-routes-to-the-destination-point-with-the-bing-map-route-data-service/VB/CalculateRoutesFromMajorRoads/MainWindow.xaml.vb#L24

Dim resultList As New StringBuilder()
resultList.Append(String.Format("Status: {0}" & ControlChars.Lf, result.ResultCode))
resultList.Append(String.Format("Fault reason: {0}" & ControlChars.Lf, result.FaultReason))