ProviderConfigurationSettings Klasse

Definition

Stellt die Basisklasse zum Anzeigen der Anbieterkonfigurationseinstellungen bereit.

public ref class ProviderConfigurationSettings abstract
public abstract class ProviderConfigurationSettings
type ProviderConfigurationSettings = class
Public MustInherit Class ProviderConfigurationSettings
Vererbung
ProviderConfigurationSettings

Beispiele

Im folgenden Beispiel wird eine benutzerdefinierte ProviderConfigSettings Klasse erstellt, die von der ProviderConfigurationSettings -Klasse abgeleitet wird. Im Beispiel werden die Anbieterkonfigurationseinstellungen geladen und initialisiert. Anschließend wird die GetSettings -Methode verwendet, um die Schlüssel-Wert-Paare abzurufen. Schließlich überprüft die Validate -Methode auf Validierung.

using System;
using System.Collections;
using System.Collections.Generic;
using Microsoft.Web.Management.Client;

namespace ConfigSnippets {
    class Program {
        static void Main(string[] args) {
            ProviderConfigSettings providerConfigSettings = new ProviderConfigSettings();
            // Load the settings.
            string[] arraysettings = { 
                "key0", "value0", 
                "key1", "value1", 
                "key2", "value2" 
            };
            providerConfigSettings.LoadSettings(arraysettings);
            Console.WriteLine("\nLoadSettings count: " + arraysettings.Length);

            // Display the settings.
            IDictionary<string, string> settings;
            settings = (IDictionary<string, string>)providerConfigSettings.GetSettings();
            Console.WriteLine("There are " + settings.Count +
                " key value pairs in ProviderConfigSettings.");
            foreach (KeyValuePair<string, string> keyValuePair in settings) {
                Console.WriteLine("  " + keyValuePair.Key + ": " + keyValuePair.Value);
            }

            // Perform a validation check on the provider configuration settings.
            string newmessage;
            bool retval = providerConfigSettings.Validate(out newmessage);
            Console.WriteLine("\nValidation returns a " + retval);
            Console.WriteLine("Validation message: " + newmessage);
        }

        public class ProviderConfigSettings : ProviderConfigurationSettings {
            IDictionary<string, string> _settings = new Dictionary<string, string>();

            // overrides the abstract Settings property.
            protected override System.Collections.IDictionary Settings {
                get {
                    return (IDictionary)_settings;
                }
            }

            // Overrides the abstract Validate method.
            public override bool Validate(out string message) {
                // Perform a validation check. If the key pairs collection
                // contains more than three pairs, pass a return value of 
                // false and a failure message.
                if (_settings.Count < 4) {
                    message = "Validation succesful";
                    return true;
                } else {
                    message = "Validation failed - too many key value pairs";
                    return false;
                }
            }
        }
    }
}

Hinweise

Mit dieser Klasse kann die abgeleitete Klasse die Einstellungen des Anbieters überprüfen.

Hinweise für Ausführende

Wenn Sie von der ProviderConfigurationSettings -Klasse erben, müssen Sie die folgenden Member überschreiben: Settings Eigenschaft und Validate(String) Methode.

Konstruktoren

ProviderConfigurationSettings()

Initialisiert eine neue Instanz der ProviderConfigurationSettings-Klasse.

Eigenschaften

ProviderSpecificSettings

Stellt die Basisklasse zum Anzeigen der Anbieterkonfigurationseinstellungen bereit.

Settings

Ruft beim Überschreiben in einer abgeleiteten Klasse die Auflistung von Einstellungen ab, die für die Hostumgebung spezifisch sind.

Methoden

GetSettings()

Gibt ein Array zurück, das die Einstellungen der Anbieterkonfiguration enthält.

LoadSettings(String[])

Lädt die Einstellungen aus dem angegebenen Array in die Anbieterkonfigurationseinstellungen.

Validate(String)

Überprüft beim Überschreiben in einer abgeleiteten Klasse die Anbieterkonfigurationseinstellungen.

Gilt für: