WebConfigurationManager.GetSection Méthode
Définition
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.
Récupère la section de configuration spécifiée à partir du fichier de configuration par défaut de l'application Web en cours.
Surcharges
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é. |
GetSection(String)
Récupère la section de configuration spécifiée à partir du fichier de configuration de l'application Web en cours.
public:
static System::Object ^ GetSection(System::String ^ sectionName);
public static object GetSection (string sectionName);
static member GetSection : string -> obj
Public Shared Function GetSection (sectionName As String) As Object
Paramètres
- sectionName
- String
Nom de la section de configuration.
Retours
Objet de la section de configuration spécifiée ou null
si la section n'existe pas. Souvenez-vous que des restrictions de sécurité s'appliquent quant à l'utilisation de GetSection(String) en tant qu'opération d'exécution. Par exemple, il se peut que vous ne puissiez pas accéder à une section pour la modifier au moment de l'exécution.
Exceptions
Un fichier de configuration valide n'a pas pu être chargé.
Exemples
Les exemples de cette section montrent comment accéder aux informations de configuration avec la GetSection méthode.
L’exemple suivant montre une section accessible à partir d’une application web ou d’une application console.
Notes
Cet exemple montre comment utiliser la GetWebApplicationSection méthode pour obtenir un ConfigurationSection objet à partir d’un fichier de configuration.
// 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
Si GetSection elle est appelée à partir d’une application web, elle obtient la section du fichier de configuration sélectionné par le système en fonction de la hiérarchie de configuration de l’application web.
Attention
Si votre application utilise un protocole différent de HTTP, la surcharge qui accepte à la GetSection fois un nom de section et un chemin d’accès dans sa liste de paramètres est celle à utiliser. Vous devez spécifier le chemin d’accès du fichier de configuration, car le système ne peut pas faire d’hypothèses au niveau de la hiérarchie de configuration. Si vous utilisez la GetSection surcharge qui prend uniquement un nom de section, le système tente toujours de retourner les paramètres de configuration au niveau de l’application. Notez toutefois que si son chemin spécifié est en dehors de l’application actuelle, la surcharge qui prend un chemin retourne également les paramètres de configuration au niveau de l’application pour l’application en cours d’exécution.
Vous pouvez appeler GetSection à partir d’une application cliente. Dans ce cas, il obtient la section par défaut du fichier de configuration sélectionné par le système en fonction de la hiérarchie de configuration du client. En règle générale, il s’agit du fichier Machine.config, sauf si vous avez une configuration mappée en place. Pour les fichiers de configuration de mappage, reportez-vous aux méthodes de mappage décrites ci-dessous.
Notes
La GetSection méthode est une méthode d’exécution qui fonctionne sur la section d’un fichier de configuration au niveau hiérarchique dans lequel l’application s’exécute. Pour une opération non exécutée, utilisez GetSection à la place. Cette méthode fonctionne sur la section spécifiée d’un fichier de configuration que vous obtenez à l’aide de l’une des méthodes surchargées pour ouvrir un fichier de configuration. OpenWebConfiguration
Notes pour les héritiers
La valeur de retour doit être convertie en type de configuration attendu avant d’être utilisée. Pour éviter les exceptions de cast possibles, vous devez utiliser une opération de cast conditionnel comme l’opérateur as
en C#.
Voir aussi
S’applique à
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é.
public:
static System::Object ^ GetSection(System::String ^ sectionName, System::String ^ path);
public static object GetSection (string sectionName, string path);
static member GetSection : string * string -> obj
Public Shared Function GetSection (sectionName As String, path As String) As Object
Paramètres
- sectionName
- String
Nom de la section de configuration.
- path
- String
Chemin d'accès virtuel du fichier de configuration.
Retours
Objet de la section de configuration spécifiée ou null
si la section n'existe pas. Souvenez-vous que des restrictions de sécurité s'appliquent quant à l'utilisation de GetSection(String, String) en tant qu'opération d'exécution. Par exemple, il se peut que vous ne puissiez pas accéder à une section pour la modifier au moment de l'exécution.
Exceptions
La méthode est appelée depuis l'extérieur d'une application Web.
Un fichier de configuration valide n'a pas pu être chargé.
Exemples
L’exemple suivant montre comment accéder aux informations de configuration avec la GetSection méthode.
Notes
Cet exemple montre comment utiliser la GetSection méthode pour obtenir un ConfigurationSection objet à partir d’un fichier de configuration spécifié.
// Show the use of GetSection(string, string).
// to access the connectionStrings section.
static void GetSection2()
{
try
{
// Get the connectionStrings section for the
// specified Web app. This GetSection overload
// can olny be called from within a Web application.
ConnectionStringsSection connectionStringsSection =
WebConfigurationManager.GetSection("connectionStrings",
"/configTest") 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 connectionStrings]");
while (connectionStringsEnum.MoveNext())
{
string name = connectionStrings[i].Name;
Console.WriteLine("Name: {0} Value: {1}",
name, connectionStrings[name]);
i += 1;
}
Console.WriteLine();
}
catch (InvalidOperationException e)
{
string errorMsg = e.ToString();
Console.WriteLine(errorMsg);
}
}
' Show the use of GetSection(string, string).
' to access the connectionStrings section.
Shared Sub GetSection2()
Try
' Get the connectionStrings section for the
' specified Web app. This GetSection overload
' can olny be called from within a Web application.
Dim connectionStringsSection As ConnectionStringsSection = _
WebConfigurationManager.GetSection( _
"connectionStrings", "/configTest")
' 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 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()
Catch e As InvalidOperationException
Dim errorMsg As String = e.ToString()
Console.WriteLine(errorMsg)
End Try
End Sub
Remarques
Si GetSection elle est appelée à partir d’une application web, elle obtient la section du fichier de configuration défini par le chemin d’accès spécifié dans la hiérarchie de configuration.
Attention
Si votre application utilise un protocole différent de HTTP, la surcharge qui accepte à la GetSection fois un nom de section et un chemin d’accès dans sa liste de paramètres est celle à utiliser. Vous devez spécifier le chemin d’accès du fichier de configuration, car le système ne peut pas faire d’hypothèses au niveau de la hiérarchie de configuration. Si vous utilisez la GetSection surcharge qui prend uniquement un nom de section, le système tente toujours de retourner les paramètres de configuration au niveau de l’application. Notez toutefois que si son chemin spécifié est en dehors de l’application actuelle, la surcharge qui prend un chemin retourne également les paramètres de configuration au niveau de l’application pour l’application en cours d’exécution.
Cette méthode ne peut pas être appelée à partir d’une application cliente.
Si vous souhaitez récupérer la section de configuration à partir du fichier de configuration situé au niveau du répertoire d’application web actuel, utilisez la GetSection méthode.
Notes
La GetSection méthode est une méthode d’exécution qui fonctionne sur la section d’un fichier de configuration au niveau hiérarchique dans lequel l’application s’exécute. Pour une opération non exécutée, utilisez GetSection à la place. Cette méthode fonctionne sur la section spécifiée d’un fichier de configuration que vous obtenez à l’aide de l’une open
des méthodes de fichier de configuration.
Notes pour les héritiers
La valeur de retour doit être convertie en type de configuration attendu avant d’être utilisée. Pour éviter les exceptions de cast possibles, vous devez utiliser une opération de cast conditionnel comme l’opérateur as
en C#.