WebConfigurationManager Classe

Référence

Définition

Espace de noms:: System.Web.Configuration

Assembly:: System.Web.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Fournit l'accès aux fichiers de configuration tels qu'ils s'appliquent aux applications Web.

public ref class WebConfigurationManager abstract sealed

public static class WebConfigurationManager

type WebConfigurationManager = class

Public Class WebConfigurationManager

Héritage: Object
WebConfigurationManager

Exemples

L’exemple suivant montre comment accéder aux informations de configuration avec le

MéthodeGetSection .


// Show how to use the GetSection(string). 
// to access the connectionStrings section.
static void GetConnectionStringsSection()
{

    // Get the connectionStrings section.
    ConnectionStringsSection connectionStringsSection =
        WebConfigurationManager.GetSection("connectionStrings")
        as ConnectionStringsSection;

    // Get the connectionStrings key,value pairs collection.
    ConnectionStringSettingsCollection connectionStrings =
        connectionStringsSection.ConnectionStrings;
   
    // Get the collection enumerator.
    IEnumerator connectionStringsEnum =
        connectionStrings.GetEnumerator();

    // Loop through the collection and 
    // display the connectionStrings key, value pairs.
    int i = 0;
    Console.WriteLine("[Display the connectionStrings]");
    while (connectionStringsEnum.MoveNext())
    {
        string name = connectionStrings[i].Name;
        Console.WriteLine("Name: {0} Value: {1}",
        name, connectionStrings[name]);
        i += 1;
    }

    Console.WriteLine();
}

' Show how to use the GetSection(string). 
' to access the connectionStrings section.
Shared Sub GetConnectionStringsSection()
   
   ' Get the connectionStrings section.
     Dim connectionStringsSection As ConnectionStringsSection = _
     WebConfigurationManager.GetSection("connectionStrings")
   
   ' Get the connectionStrings key,value pairs collection.
     Dim connectionStrings As ConnectionStringSettingsCollection = _
     connectionStringsSection.ConnectionStrings
   
   ' Get the collection enumerator.
     Dim connectionStringsEnum As IEnumerator = _
     connectionStrings.GetEnumerator()
   
   ' Loop through the collection and 
   ' display the connectionStrings key, value pairs.
   Dim i As Integer = 0
   Console.WriteLine("[Display the connectionStrings]")
   While connectionStringsEnum.MoveNext()
      Dim name As String = connectionStrings(i).Name
         Console.WriteLine("Name: {0} Value: {1}", _
         name, connectionStrings(name))
      i += 1
   End While
   
   Console.WriteLine()
End Sub

Remarques

La WebConfigurationManager classe vous permet d’accéder aux informations de l’ordinateur et de l’application.

L’utilisation WebConfigurationManager est la meilleure façon d’utiliser les fichiers de configuration liés aux applications Web. Pour les applications clientes, utilisez la ConfigurationManager classe.

Votre application peut étendre les System.Configuration types ou les utiliser directement pour gérer les informations de configuration, comme expliqué dans la liste suivante :

Handling configuration. Pour gérer les informations de configuration à l’aide des types standard, vous utilisez l’une des approches suivantes :
- Accessing a section. Pour accéder aux informations de configuration de votre application, vous devez utiliser l’une GetSection des méthodes fournies par WebConfigurationManager. Pour <appSettings> et <connectionStrings>, vous utilisez les propriétés et ConnectionStrings les AppSettings propriétés. Ces méthodes effectuent des opérations en lecture seule, utilisent une seule instance mise en cache de la configuration et prennent en charge les multithreads.
- Accessing configuration files. Votre application peut lire et écrire des paramètres de configuration à n’importe quel niveau, pour lui-même ou pour d’autres applications ou ordinateurs, localement ou à distance. Vous utilisez l’une des open méthodes fournies par WebConfigurationManager. Ces méthodes retournent un Configuration objet, qui fournit à son tour les méthodes et propriétés requises pour gérer les fichiers de configuration sous-jacents. Ces méthodes effectuent des opérations de lecture ou d’écriture et recréent les données de configuration chaque fois qu’un fichier est ouvert.
- Advanced configuration. La gestion de la configuration plus avancée est fournie par les types SectionInformation, , PropertyInformation, PropertyInformationCollection ElementInformation, ContextInformation, ConfigurationSectionGroupet ConfigurationSectionGroupCollection.
Extending configuration standard types. Vous pouvez également fournir vos éléments de configuration personnalisés en étendant les types de configuration standard tels que ConfigurationElement, ConfigurationElementCollection, ConfigurationPropertyet ConfigurationSection en utilisant un modèle programmatique ou attribut. Reportez-vous à la ConfigurationSection classe pour obtenir un exemple d’extension d’un type de configuration standard par programmation. Reportez-vous à la ConfigurationElement classe pour obtenir un exemple d’extension d’un type de configuration standard à l’aide du modèle attribué.

Notes pour les héritiers

La Configuration classe autorise l’accès par programmation pour la modification des fichiers de configuration. Vous utilisez l’une des méthodes ouvertes fournies par WebConfigurationManager. Ces méthodes retournent un Configuration objet, qui fournit à son tour les méthodes et propriétés requises pour gérer les fichiers de configuration sous-jacents. Vous pouvez accéder à ces fichiers pour la lecture ou l’écriture comme suit : Vous utilisez GetSection(String) ou GetSectionGroup(String) lisez les informations de configuration. Notez que l’utilisateur ou le processus lu doit disposer des autorisations suivantes :

Autorisation de lecture sur le fichier de configuration au niveau de la hiérarchie de configuration actuelle.
Autorisations de lecture sur tous les fichiers de configuration parent.

Si votre application a besoin d’un accès en lecture seule à sa propre configuration, il est recommandé d’utiliser les GetSection méthodes. Ces méthodes fournissent un accès aux valeurs de configuration mises en cache pour l’application actuelle, ce qui offre de meilleures performances que la Configuration classe.

Remarque : Si vous utilisez une méthode statique GetSection qui accepte un path paramètre, le paramètre path doit faire référence à l’application dans laquelle le code est en cours d’exécution ; sinon, le paramètre est ignoré et les informations de configuration de l’application en cours d’exécution sont retournées.

Vous utilisez l’une des Save méthodes pour écrire des informations de configuration. Notez que l’utilisateur ou le processus qui écrit doit disposer des autorisations suivantes :

Autorisation d’écriture sur le fichier de configuration et le répertoire au niveau de la hiérarchie de configuration actuelle.
Autorisations de lecture sur tous les fichiers de configuration.

Propriétés

AppSettings	Obtient les paramètres d'application du site Web.
ConnectionStrings	Obtient les chaînes de connexion du site Web.

Méthodes

GetSection(String)	Récupère la section de configuration spécifiée à partir du fichier de configuration de l'application Web en cours.
GetSection(String, String)	Récupère la section de configuration spécifiée à partir du fichier de configuration de l'application Web à l'emplacement spécifié.
GetWebApplicationSection(String)	Récupère la section de configuration spécifiée à partir du fichier de configuration de l'application Web en cours.
OpenMachineConfiguration()	Ouvre le fichier de configuration de l'ordinateur sur l'ordinateur actuel en tant qu'objet Configuration afin d'autoriser les opérations de lecture ou d'écriture.
OpenMachineConfiguration(String)	Ouvre le fichier de configuration de l'ordinateur sur l'ordinateur actuel en tant qu'objet Configuration afin d'autoriser les opérations de lecture ou d'écriture.
OpenMachineConfiguration(String, String)	Ouvre le fichier de configuration de l'ordinateur spécifié sur le serveur déterminé en tant qu'objet Configuration afin d'autoriser les opérations de lecture ou d'écriture.
OpenMachineConfiguration(String, String, IntPtr)	Ouvre le fichier de configuration de l'ordinateur spécifié sur le serveur déterminé en tant qu'objet Configuration, à l'aide du contexte de sécurité spécifié afin d'autoriser les opérations de lecture ou d'écriture.
OpenMachineConfiguration(String, String, String, String)	Ouvre le fichier de configuration de l'ordinateur spécifié sur le serveur déterminé en tant qu'objet Configuration, à l'aide du contexte de sécurité spécifié afin d'autoriser les opérations de lecture ou d'écriture.
OpenMappedMachineConfiguration(ConfigurationFileMap)	Ouvre le fichier de configuration de l'ordinateur en tant qu'objet Configuration, à l'aide du mappage de fichiers spécifié afin d'autoriser les opérations de lecture ou d'écriture.
OpenMappedMachineConfiguration(ConfigurationFileMap, String)	Ouvre le fichier de configuration de l'ordinateur en tant qu'objet Configuration, à l'aide de l'emplacement et du mappage de fichiers spécifiés, afin d'autoriser les opérations de lecture ou d'écriture.
OpenMappedWebConfiguration(WebConfigurationFileMap, String)	Ouvre le fichier de configuration de l'application Web spécifiée en tant qu'objet Configuration, à l'aide du mappage de fichiers et du chemin d'accès virtuel spécifiés, afin d'autoriser les opérations de lecture ou d'écriture.
OpenMappedWebConfiguration(WebConfigurationFileMap, String, String)	Ouvre le fichier de configuration de l'application Web spécifiée en tant qu'objet Configuration, à l'aide du mappage de fichiers, du chemin d'accès virtuel et du nom du site spécifiés, afin d'autoriser les opérations de lecture ou d'écriture.
OpenMappedWebConfiguration(WebConfigurationFileMap, String, String, String)	Ouvre le fichier de configuration de l'application Web spécifiée en tant qu'objet Configuration, à l'aide du mappage de fichiers, du chemin d'accès virtuel, du nom du site et de l'emplacement spécifiés, afin d'autoriser les opérations de lecture ou d'écriture.
OpenWebConfiguration(String)	Ouvre le fichier de configuration de l'application Web en tant qu'objet Configuration, à l'aide du chemin d'accès virtuel spécifié, afin d'autoriser les opérations de lecture ou d'écriture.
OpenWebConfiguration(String, String)	Ouvre le fichier de configuration de l'application Web en tant qu'objet Configuration, à l'aide du chemin d'accès virtuel et du nom du site spécifiés, afin d'autoriser les opérations de lecture ou d'écriture.
OpenWebConfiguration(String, String, String)	Ouvre le fichier de configuration de l'application Web en tant qu'objet Configuration, à l'aide du chemin d'accès virtuel, du nom du site et de l'emplacement spécifiés, afin d'autoriser les opérations de lecture ou d'écriture.
OpenWebConfiguration(String, String, String, String)	Ouvre le fichier de configuration de l'application Web en tant qu'objet Configuration, à l'aide du chemin d'accès virtuel, du nom du site, de l'emplacement et du serveur spécifiés, afin d'autoriser les opérations de lecture ou d'écriture.
OpenWebConfiguration(String, String, String, String, IntPtr)	Ouvre le fichier de configuration de l'application Web en tant qu'objet Configuration, à l'aide du chemin d'accès virtuel, du nom du site, de l'emplacement, du serveur et du contexte de sécurité spécifiés, afin d'autoriser les opérations de lecture ou d'écriture.
OpenWebConfiguration(String, String, String, String, String, String)	Ouvre le fichier de configuration de l'application Web en tant qu'objet Configuration, à l'aide du chemin d'accès virtuel, du nom du site, de l'emplacement, du serveur et du contexte de sécurité spécifiés, afin d'autoriser les opérations de lecture ou d'écriture.

S’applique à