appSettings-Element (allgemeines Einstellungsschema)

Artikel
08/10/2011

Enthält benutzerdefinierte Anwendungseinstellungen wie Dateipfade, XML-Webdienst-URLs oder sonstige Informationen, die in der INI-Datei einer Anwendung gespeichert sind.

<appSettings
   file="relative file name" >
</appSettings>

Attribute und Elemente

In den folgenden Abschnitten werden Attribute, untergeordnete Elemente und übergeordnete Elemente beschrieben.

Attribute

Element	Beschreibungen
file	Optionales String-Attribut. Gibt einen relativen Pfad zu einer externen Datei an, die benutzerdefinierte Einstellungen für die Anwendungskonfiguration enthält. Die angegebene Datei enthält die gleiche Art von Einstellungen, wie sie auch in den appSettings-Elementen add, clear und remove angegeben sind, und verwendet das gleiche Format aus Schlüssel-Wert-Paaren wie diese Elemente. Der Pfad wird relativ zur lokalen Konfigurationsdatei angegeben. Das Attribut wird während der Laufzeit ignoriert, wenn die angegebene Datei nicht gefunden wird. Da jegliche Änderung der Datei Web.config einen Neustart der Anwendung verursacht, können Werte aus dem Abschnitt appSettings nur mithilfe einer separaten Datei vom Benutzer geändert werden, ohne dass die Anwendung neu gestartet wird. Der Inhalt der separaten Datei wird mit dem Abschnitt appSettings in der Datei Web.config zusammengeführt. Diese Funktionalität ist auf das appSettings-Attribut beschränkt. Hinweis°°°In .NET Framework, Version 2.0, können Sie ab sofort für alle Konfigurationselemente, die das configSource-Attribut unterstützen, die Konfigurationseinstellungen in eine separate Datei einfügen. Wenn Sie das configSource-Attribut verwenden, müssen Sie jedoch den gesamten Abschnitt in die separate Datei einfügen, da die Elementeinstellungen nicht zusammengeführt werden. Bei Verwendung des configSource-Attributs wird nur einmalig in die Datei Web.config geschrieben. Dies verursacht einen Neustart der Anwendung. Nachfolgende Aktualisierungen des Abschnitts werden dagegen direkt in die separate Datei geschrieben und verursachen keine weiteren Neustarts der Anwendung. Weitere Informationen finden Sie unter ConfigSource.
Geerbte Attribute	Optionale Attribute. Attribute, die von allen Abschnittselementen geerbt werden.

file

Optionales String-Attribut.

Gibt einen relativen Pfad zu einer externen Datei an, die benutzerdefinierte Einstellungen für die Anwendungskonfiguration enthält. Die angegebene Datei enthält die gleiche Art von Einstellungen, wie sie auch in den appSettings-Elementen add, clear und remove angegeben sind, und verwendet das gleiche Format aus Schlüssel-Wert-Paaren wie diese Elemente.

Der Pfad wird relativ zur lokalen Konfigurationsdatei angegeben. Das Attribut wird während der Laufzeit ignoriert, wenn die angegebene Datei nicht gefunden wird.

Da jegliche Änderung der Datei Web.config einen Neustart der Anwendung verursacht, können Werte aus dem Abschnitt appSettings nur mithilfe einer separaten Datei vom Benutzer geändert werden, ohne dass die Anwendung neu gestartet wird. Der Inhalt der separaten Datei wird mit dem Abschnitt appSettings in der Datei Web.config zusammengeführt. Diese Funktionalität ist auf das appSettings-Attribut beschränkt.

Hinweis°°°In .NET Framework, Version 2.0, können Sie ab sofort für alle Konfigurationselemente, die das configSource-Attribut unterstützen, die Konfigurationseinstellungen in eine separate Datei einfügen. Wenn Sie das configSource-Attribut verwenden, müssen Sie jedoch den gesamten Abschnitt in die separate Datei einfügen, da die Elementeinstellungen nicht zusammengeführt werden. Bei Verwendung des configSource-Attributs wird nur einmalig in die Datei Web.config geschrieben. Dies verursacht einen Neustart der Anwendung. Nachfolgende Aktualisierungen des Abschnitts werden dagegen direkt in die separate Datei geschrieben und verursachen keine weiteren Neustarts der Anwendung. Weitere Informationen finden Sie unter ConfigSource.

Geerbte Attribute

Optionale Attribute.

Attribute, die von allen Abschnittselementen geerbt werden.

Untergeordnete Elemente

Element	Beschreibungen
add	Optionales Element Fügt der Auflistung der Anwendungseinstellungen eine benutzerdefinierte Anwendungseinstellung als Name-Wert-Paar hinzu.
clear	Optionales Element Entfernt alle Verweise auf geerbte benutzerdefinierte Anwendungseinstellungen bis auf die vom aktuellen add-Attribut hinzugefügten Verweise.
remove	Optionales Element Entfernt einen Verweis auf eine geerbte benutzerdefinierte Anwendungseinstellung aus der Auflistung der Anwendungseinstellungen.

add

Optionales Element

Fügt der Auflistung der Anwendungseinstellungen eine benutzerdefinierte Anwendungseinstellung als Name-Wert-Paar hinzu.

clear

Optionales Element

Entfernt alle Verweise auf geerbte benutzerdefinierte Anwendungseinstellungen bis auf die vom aktuellen add-Attribut hinzugefügten Verweise.

remove

Optionales Element

Entfernt einen Verweis auf eine geerbte benutzerdefinierte Anwendungseinstellung aus der Auflistung der Anwendungseinstellungen.

Übergeordnete Elemente

Element	Beschreibungen
configuration	Gibt das erforderliche Stammelement in jeder Konfigurationsdatei an, die von der Common Language Runtime und den .NET Framework-Anwendungen verwendet wird.
system.web	Gibt das Stammelement für die ASP.NET-Konfigurationseinstellungen in einer Konfigurationsdatei an und enthält Konfigurationselemente, die ASP.NET-Webanwendungen konfigurieren und das Verhalten der Anwendungen steuern.

Hinweise

Das appSettings-Element enthält benutzerdefinierte Anwendungskonfigurationsinformationen wie Dateipfade, XML-Webdienst-URLs oder sonstige Informationen, die in der INI-Datei einer Anwendung gespeichert sind. Der Zugriff auf die im appSettings-Element angegebenen Schlüssel-Wert-Paare erfolgt im Code über die ConfigurationManager-Klasse. Weitere Informationen dazu, wie programmgesteuert auf appSettings zugegriffen wird, finden Sie im Codebeispiel in der Klasse.

Mit dem file-Attribut können Sie eine Konfigurationsdatei festlegen, die zusätzliche Einstellungen bereitstellt oder die im appSettings-Element angegebenen Einstellungen überschreibt. Das file-Attribut kann in Teamentwicklerszenarios mit Quellcodeverwaltung verwendet werden, z. B. wenn ein Benutzer die in einer Anwendungskonfigurationsdatei angegebenen Projekteinstellungen überschreiben möchte. Konfigurationsdateien, die in einem file-Attribut angegeben sind, müssen das appSettings-Element und nicht das configuration-Element als Stammknoten verwenden.

In Anwendungen für .NET Framework, Version 2.0, werden Datenbankverbindungszeichenfolgen in der connectionStrings-Element (ASP.NET-Einstellungsschema)-Auflistung anstatt in der Auflistung der Anwendungseinstellungen gespeichert.

Standardkonfiguration

Das folgende appSettings-Standardelement wird nicht explizit in der Datei Machine.config oder der Stammdatei Web.config konfiguriert. Es ist jedoch die Standardkonfiguration, die von der Anwendung zurückgegeben wird.

   <appSettings file="">
      <settings>
         <clear />
      </settings>
   </appSettings>

Beispiel

Konfigurationsdateien, die in einem file-Attribut angegeben sind, müssen das appSettings-Element und nicht das configuration-Element als Stammknoten verwenden.

Das folgende Codebeispiel zeigt, wie Sie die richtige Form für eine Konfigurationsdatei verwenden, die im file-Attribut angegeben ist:

<?xml version="1.0" encoding="utf-8" ?>
<appSettings>
<add key="Application1" value="MyApplication1" />
<add key="Setting1" value="MySetting" />
</appSettings>

Das folgende Codebeispiel veranschaulicht, wie Sie eine benutzerdefinierte Anwendungseinstellung in einer Konfigurationsdatei definieren.

<configuration>
    <appSettings>
        <add key="Application Name" value="MyApplication" />
    </appSettings>
</configuration>

Elementinformationen

Konfigurationsabschnittshandler	AppSettingsSection
Konfigurationsmember	AppSettings AppSettings AppSettings
Konfigurierbare Speicherorte	Machine.config Web.config auf der Stammebene Web.config auf der Anwendungsebene Web.config auf der Ebene virtueller oder physikalischer Verzeichnisse
Anforderungen	Microsoft Internetinformationsdienste (IIS), Version 5.0, 5.1 oder 6.0 .NET Framework, Version 1.0, 1.1 oder 2.0 Microsoft Visual Studio 2003 oder Visual Studio 2005

Siehe auch

appSettings-Element (allgemeines Einstellungsschema)

Attribute und Elemente

Attribute

Untergeordnete Elemente

Übergeordnete Elemente

Hinweise

Standardkonfiguration

Beispiel

Elementinformationen

Siehe auch

Referenz

Konzepte

Weitere Ressourcen

Zusätzliche Ressourcen