ILocatorWorkspace.AddLocator Method

Adds a locator to the locator workspace.

[Visual Basic .NET]
Public Function AddLocator ( _
    ByVal Name As String, _
    ByVal locator As ILocator, _
    ByVal ConfigKeyword As String, _
    ByVal CancelTracker As ITrackCancel _
) As ILocator

[C#]
public ILocator AddLocator (
    string Name,
    ILocator locator,
    string ConfigKeyword,
    ITrackCancel CancelTracker
);

[C++]
HRESULT AddLocator(
  BSTR Name,
  ILocator* locator,
  BSTR ConfigKeyword,
  ITrackCancel* CancelTracker
);

[C++]
Parameters
Name [in]

  Name is a parameter of type BSTR
locator [in]

  locator is a parameter of type ILocator*
ConfigKeyword [in]

  ConfigKeyword is a parameter of type BSTR
CancelTracker [in]

  CancelTracker is a parameter of type ITrackCancel*

Product Availability

Description

The AddLocator method adds the specified locator to the locator workspace with the specified name.

Remarks

In general, when creating a locator, you will first retrieve a locator style from the locator workspace, set the properties on the locator style, then use the AddLocator method to create a new locator.

The Name parameter specifies the name for the new locator.

The Locator parameter is a reference to the locator that you want to add to the locator workspace.

The ConfigKeyword parameter is used to specify the ArcSDE storage keyword used to create the reference data indexes for the new locator. This parameter is only used if the locator workspace is in an ArcSDE database. Using a configuration keyword specifies certain parameters for storing tables to the ArcSDE database, and the proper configuration can improve the performance of your locators. For more information on ArcSDE configuration keywords, refer to the ArcSDE Configuration and Tuning Guide for your relational database management system (RDBMS). To use the default storage keyword for the ArcSDE database, specify a blank string for this parameter.

ICancelTracker is an optional parameter that you can use to specify a CancelTracker object that is used to display the reference data index building progress and allows the user to cancel the process.

See Also

ILocatorWorkspace Interface | ILocatorWorkspace.AddLocator Method | ILocatorWorkspace.DeleteLocator Method | ILocatorWorkspace.CopyLocator Method