This topic has not yet been rated - Rate this topic

ProviderConfigurationSettings Class

Provides the base class for displaying the provider configuration settings.

System..::..Object
Microsoft.Web.Management.Client..::..ProviderConfigurationSettings

Namespace: Microsoft.Web.Management.Client
Assembly: Microsoft.Web.Management (in Microsoft.Web.Management.dll)

[SecurityPermissionAttribute(SecurityAction.Demand, Flags = SecurityPermissionFlag.UnmanagedCode)]
[SecurityPermissionAttribute(SecurityAction.InheritanceDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
public abstract class ProviderConfigurationSettings

The ProviderConfigurationSettings type exposes the following members.

Constructors

	Name	Description
	ProviderConfigurationSettings	Initializes a new instance of the ProviderConfigurationSettings class.

Top

Properties

	Name	Description
	ProviderSpecificSettings	Gets the System.Collections..::..IList interface that contains the collection of provider specific settings.
	Settings	When overridden in a derived class, gets the collection of settings that are specific to the host environment.

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetSettings	Returns an array that contains the settings of the provider configuration.
	GetType	(Inherited from Object.)
	LoadSettings	Loads the settings from the specified array into the provider configuration settings.
	MemberwiseClone	(Inherited from Object.)
	ToString	(Inherited from Object.)
	Validate	When overridden in a derived class, validates the provider configuration settings.

Top

Remarks

This class enables the derived class to check the settings of the provider.

Notes to Inheritors

When you inherit from the ProviderConfigurationSettings class, you must override the following members: Settings property and Validate method.

Examples

The following example builds a custom ProviderConfigSettings class, which is derived from the ProviderConfigurationSettings class. The example loads and initializes the provider configuration settings and then uses the GetSettings method to obtain the key/value pairs. Finally, the Validate method checks for validation.

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;
                }
            }
        }
    }
}

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

Microsoft.Web.Management.Client Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD