WebConfigurationManager.GetSection Metod
Definition
Viktigt
En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.
Hämtar det angivna konfigurationsavsnittet från det aktuella webbprogrammets standardkonfigurationsfil.
Överlagringar
| Name | Description |
|---|---|
| GetSection(String) |
Hämtar det angivna konfigurationsavsnittet från det aktuella webbprogrammets konfigurationsfil. |
| GetSection(String, String) |
Hämtar det angivna konfigurationsavsnittet från webbprogrammets konfigurationsfil på den angivna platsen. |
GetSection(String)
Hämtar det angivna konfigurationsavsnittet från det aktuella webbprogrammets konfigurationsfil.
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
Parametrar
- sectionName
- String
Namnet på konfigurationsavsnittet.
Returer
Det angivna konfigurationsavsnittsobjektet eller null om avsnittet inte finns. Kom ihåg att det finns säkerhetsbegränsningar för användning av GetSection(String) som en körningsåtgärd. Du kanske inte kan komma åt ett avsnitt vid körning för ändringar, till exempel.
Undantag
Det gick inte att läsa in en giltig konfigurationsfil.
Exempel
Exemplen i det här avsnittet visar hur du kommer åt konfigurationsinformation med GetSection metoden.
I följande exempel visas ett avsnitt som kan nås från antingen ett webbprogram eller ett konsolprogram.
Note
Det här exemplet visar hur du använder GetWebApplicationSection metoden för att hämta ett ConfigurationSection objekt från en konfigurationsfil.
// 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
Kommentarer
Om GetSection anropas inifrån ett webbprogram hämtas avsnittet från konfigurationsfilen som valts av systemet enligt konfigurationshierarkin för webbprogram.
Caution
Om ditt program använder ett annat protokoll än HTTP är den GetSection överlagring som tar både ett avsnittsnamn och en sökväg i parameterlistan den som ska användas. Du måste ange sökvägen till konfigurationsfilen eftersom systemet inte kan göra några antaganden om konfigurationshierarkinivån. Om du använder överbelastningen GetSection som bara tar ett avsnittsnamn försöker systemet alltid returnera konfigurationsinställningarna på programnivå. Observera dock att om den angivna sökvägen ligger utanför det aktuella programmet returnerar den överlagring som tar en sökväg även konfigurationsinställningarna på programnivå för det program som körs.
Du kan anropa GetSection inifrån ett klientprogram. I det här fallet hämtas standardavsnittet från konfigurationsfilen som valts av systemet enligt klientkonfigurationshierarkin. Detta är vanligtvis den Machine.config filen, såvida du inte har en mappad konfiguration på plats. För mappning av konfigurationsfiler, se de mappningsmetoder som beskrivs härnäst.
Note
Metoden GetSection är en körningsmetod som körs i avsnittet i en konfigurationsfil på hierarkinivå där programmet körs. Använd i stället för en icke-körningsåtgärd GetSection . Den här metoden fungerar i det angivna avsnittet i en konfigurationsfil som du får med någon av de överlagrade metoderna för att öppna en konfigurationsfil, OpenWebConfiguration.
Anteckningar till arvingar
Returvärdet måste omvandlas till den förväntade konfigurationstypen innan det används. För att undvika möjliga undantag för gjutning bör du använda en villkorlig gjutningsåtgärd som operatorn as i C#.
Se även
Gäller för
GetSection(String, String)
Hämtar det angivna konfigurationsavsnittet från webbprogrammets konfigurationsfil på den angivna platsen.
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
Parametrar
- sectionName
- String
Namnet på konfigurationsavsnittet.
- path
- String
Sökvägen till den virtuella konfigurationsfilen.
Returer
Det angivna konfigurationsavsnittsobjektet eller null om avsnittet inte finns. Kom ihåg att det finns säkerhetsbegränsningar för användningen av GetSection(String, String) som en körningsåtgärd. Du kanske inte kan komma åt ett avsnitt vid körning för ändringar, till exempel.
Undantag
Metoden anropas utanför ett webbprogram.
Det gick inte att läsa in en giltig konfigurationsfil.
Exempel
I följande exempel visas hur du kommer åt konfigurationsinformation med GetSection -metoden.
Note
Det här exemplet visar hur du använder GetSection metoden för att hämta ett ConfigurationSection objekt från en angiven konfigurationsfil.
// 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
Kommentarer
Om GetSection anropas inifrån ett webbprogram hämtas avsnittet från konfigurationsfilen som definieras av den angivna sökvägen i konfigurationshierarkin.
Caution
Om ditt program använder ett annat protokoll än HTTP är den GetSection överlagring som tar både ett avsnittsnamn och en sökväg i parameterlistan den som ska användas. Du måste ange sökvägen till konfigurationsfilen eftersom systemet inte kan göra några antaganden om konfigurationshierarkinivån. Om du använder överbelastningen GetSection som bara tar ett avsnittsnamn försöker systemet alltid returnera konfigurationsinställningarna på programnivå. Observera dock att om den angivna sökvägen ligger utanför det aktuella programmet returnerar den överlagring som tar en sökväg även konfigurationsinställningarna på programnivå för det program som körs.
Den här metoden kan inte anropas inifrån ett klientprogram.
Om du vill hämta konfigurationsavsnittet från konfigurationsfilen som finns på den aktuella katalognivån för webbprogram använder du GetSection metoden .
Note
Metoden GetSection är en körningsmetod som körs i avsnittet i en konfigurationsfil på hierarkinivå där programmet körs. Använd i stället för en icke-körningsåtgärd GetSection . Den här metoden fungerar i det angivna avsnittet i en konfigurationsfil som du får med någon av konfigurationsfilmetoderna open .
Anteckningar till arvingar
Returvärdet måste omvandlas till den förväntade konfigurationstypen innan det används. För att undvika möjliga undantag för gjutning bör du använda en villkorlig gjutningsåtgärd som operatorn as i C#.