IConfigurationKeyword Interface

Provides access to members to supply information about configuration keywords.

Description

This interface is used for retrieving the properties of a configuration keyword.

When To Use

Use the IConfigurationKeyword interface to get information about a configuration keyword. For example, through this interface, you can retrieve a name, description and the set of configuration parameters that this keyword represents.

Members

Name Description
Read-only property Comments Any additional comments about the keyword.
Read-only property ConfigurationParameters Configuration parameters included in this keyword.
Read-only property Description The description of the keyword.
Read-only property KeywordType The type of the keyword.
Read-only property Name The name of the keyword.

IConfigurationKeyword.Comments Property

Any additional comments about the keyword.

Public ReadOnly Property Comments As String
public string Comments {get;}

Remarks

Configuration keywords in an ArcSDE or File geodatabase can have descriptions associated with them. A keyword's description is text that describes what the configuration keyword is used for.

IConfigurationKeyword.ConfigurationParameters Property

Configuration parameters included in this keyword.

Public ReadOnly Property ConfigurationParameters As IEnumConfigurationParameter
public IEnumConfigurationParameter ConfigurationParameters {get;}

Remarks

Configuration keywords in an ArcSDE or File geodatabase are used to specify storage parameters for feature class, tables and geometric networks. These storage parameters can be accessed through the IConfigurationParametersinterface. This method returns a collection of parameters for a configuration keyword.

IConfigurationKeyword.Description Property

The description of the keyword.

Public ReadOnly Property Description As String
public string Description {get;}

Remarks

Configuration keywords in an ArcSDE or File geodatabase can have descriptions associated with them. A keyword's description is a user-friendly string that describes the configuration keyword.

IConfigurationKeyword.KeywordType Property

The type of the keyword.

Public ReadOnly Property KeywordType As esriConfigurationKeywordType
public esriConfigurationKeywordType KeywordType {get;}

IConfigurationKeyword.Name Property

The name of the keyword.

Public ReadOnly Property Name As String
public string Name {get;}

Classes that implement IConfigurationKeyword

Classes Description
ConfigurationKeyword ConfigurationKeyword Object.

Remarks

Configuration keywords are used in an ArcSDE or File geodatabase to specify storage parameters for new tables, feature classes and other datasets such as geometric networks, topologies and terrains when they are created. Configuration keywords can be of several different types:

  • esriConfigurationKeywordGeneral which references storage parameters for creating feature classes and tables
  • esriConfigurationKeywordNetwork which reference storage parameters for creating geometric networks
  • esriConfigurationKeywordTopology which reference storage parameters for creating topologies
  • esriConfigurationKeywordTerrain which reference storage parameters for creating terrain datasets
  • esriConfigurationKeywordNetworkDatasets which reference storage parameters for creating network datasets

The following are examples of some of the methods that accept configuration keywords. These methods do not require an IConfigurationKeyword parameter, but can accept a configuration keyword as a string:

IFeatureWorkspace.CreateFeatureClassIFeatureWorkspace.CreateTableIFeatureDataset.CreateFeatureClassIClassSchemaEdit.RergisterAsObjectClassIFeatureDataConverter.ConvertFeatureClass

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.