ArcObjects Library Reference  (GeoDatabase)    

ILocatorWorkspace.GetLocator Method

Gets a locator.

[Visual Basic 6.0]
Function GetLocator(
    ByVal Name As String _
) As ILocator
[Visual Basic .NET]
Public Function GetLocator ( _
    ByVal Name As String _
) As ILocator
[C#]
public ILocator GetLocator (
    string Name
);
[Java]
public ILocator getLocator (
    String Name
)
throws
    IOException,
    AutomationException
[C++]
HRESULT GetLocator(
  BSTR Name,
  ILocator** locator
);
[C++]

Parameters

Name [in]

  Name is a parameter of type BSTR

locator [out, retval]

  locator is a parameter of type ILocator

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Description

The GetLocator method retrieves a locator from a locator workspace.

Remarks

The Name parameter is the name of the locator that you want to retrieve from the locator workspace.

Within the default local locator workspace, and within ArcSDE locator workspaces, locator names are prefixed by a user name, as in "jack.My Locator". In local locator workspaces, the locator name is prefixed by the user name of the current user. In ArcSDE workspaces, the locator name is prefixed by the name of the ArcSDE user that owns the locator. When you call methods in ArcObjects that have parameters that specify locators in a locator workspace, you must specify the full name of the locator, including the user name. Failing to do so will result in an error.  

See Also

ILocatorWorkspace Interface | ILocatorWorkspace.GetLocator Method | ILocatorWorkspace.UpdateLocator Method | ILocator Interface | ESRIFDOAddressLocatorStyle Class | ESRIFDOAddressLocator Class | StreetMapAddressLocatorStyle Class | StreetMapAddressLocator Class | LocatorExtension Class | GxLocator Class | IAddressUI.RematchTable Method