Contents

geocodeAddressString(_:in:preferredLocale:completionHandler:)

Submits a forward-geocoding requesting using the specified address string and locale information.

Declaration

func geocodeAddressString(_ addressString: String, in region: CLRegion?, preferredLocale locale: Locale?, completionHandler: @escaping  @Sendable ([CLPlacemark]?, (any Error)?) -> Void)
func geocodeAddressString(_ addressString: String, in region: CLRegion?, preferredLocale locale: Locale?) async throws -> [CLPlacemark]

Parameters

  • addressString:

    A string describing the location you want to look up. For example, you could specify the string “1 Infinite Loop, Cupertino, CA” to locate Apple headquarters.

  • region:

    A geographical region to use as a hint when looking up the specified address. Specifying a region lets you prioritize the returned set of results to locations that are close to some specific geographical area, which is typically the user’s current location. If the application is authorized for location services and you specify nil for this parameter, the set of results is prioritized based on the user’s approximate location. Calling this method does not trigger a location services authorization request.

  • locale:

    The locale of the address string. Specify nil to use the current locale of the user.

  • completionHandler:

    The handler block to execute with the results. The geocoder executes this handler regardless of whether the request was successful or unsuccessful. For more information on the format of this block, see Clgeocodecompletionhandler.

Discussion

This method submits the specified location data to the geocoding server asynchronously and returns. When the request completes, the geocoder executes the provided completion handler on the main thread.

After initiating a forward-geocoding request, do not attempt to initiate another reverse- or forward-geocoding request. Geocoding requests are rate-limited for each app, so making too many requests in a short period of time may cause some of the requests to fail. When the maximum rate is exceeded, the geocoder passes an error object with the value network to your completion handler.

See Also

Geocoding an address