GeocodeServiceClient.Geocode Method

Finds a geographic location based on a request that may include the address, place, or entity type names to find.

Syntax

public GeocodeResponse Geocode(GeocodeRequest request)

Public Function Geocode(ByVal request As GeocodeRequest) As GeocodeResponse

Parameters

Return Value

Returns a GeocodeResponse Class, which contains a GeocodeResult Class array.

Example

private void MakeGeocodeRequest() {
    string Results = "";
    try {
        //  Set a Bing Maps key before making a request 
        string key = "Bing Maps Key";
        GeocodeService.GeocodeRequest geocodeRequest = new GeocodeService.GeocodeRequest();
        //  Set the credentials using a valid Bing Maps Key 
        geocodeRequest.Credentials = new GeocodeService.Credentials();
        geocodeRequest.Credentials.ApplicationId = key;
        //  Set the full address query 
        geocodeRequest.Query = "1 Microsoft Way, Redmond, WA";
        //  Set the options to only return high confidence results 
        GeocodeService.ConfidenceFilter[] filters = new GeocodeService.ConfidenceFilter[1];
        filters[0] = new GeocodeService.ConfidenceFilter();
        filters[0].MinimumConfidence = GeocodeService.Confidence.High;
        GeocodeService.GeocodeOptions geocodeOptions = new GeocodeService.GeocodeOptions();
        geocodeOptions.Filters = filters;
        geocodeRequest.Options = geocodeOptions;
        //  Make the geocode request 
        GeocodeService.GeocodeServiceClient geocodeService = new GeocodeService.GeocodeServiceClient("BasicHttpBinding_IGeocodeService");
        GeocodeService.GeocodeResponse geocodeResponse = geocodeService.Geocode(geocodeRequest);
        Results = geocodeResponse.Results[0].DisplayName;
    } catch (Exception ex) {
        Results = "An exception occurred: " + ex.Message;
    }
}

Private Sub MakeGeocodeRequest() Dim Results As String 
    Try
'   Set a Bing Maps key before making a request 
    Dim key = "Bing Maps Key" Dim geocodeRequest As New GeocodeService.GeocodeRequest()
'   Set the credentials using a valid Bing Maps Key 
    geocodeRequest.Credentials = _ New GeocodeService.Credentials() With {
    .ApplicationId = key
    }
'   Set the full address query 
    geocodeRequest.Query = "1 Microsoft Way, Redmond, WA"
'   Set the options to only return high confidence results 
    Dim filters() As GeocodeService.ConfidenceFilter = _ {
        New GeocodeService.ConfidenceFilter() _ With {
            .MinimumConfidence = GeocodeService.Confidence.High
        }
    } 

    Dim geocodeOptions As New GeocodeService.GeocodeOptions() _ With {
    .Filters = filters
    } 

    geocodeRequest.Options = geocodeOptions
'   Make the geocode request 
    Dim geocodeServiceInstance As New GeocodeService.GeocodeServiceClient("BasicHttpBinding_IGeocodeService") 
    Dim geocodeResponse = geocodeServiceInstance.Geocode(geocodeRequest)
'   Use the results in your application. 
    Results = geocodeResponse.Results(0).DisplayName Catch ex As Exception Results = "An exception occurred: " & ex.Message 
    End Try 
End Sub

See Also

GeocodeServiceClient.ReverseGeocode Method