C# – Sharepoint web.config changes using SPWebConfigModification

csharepointweb.config

I've written a sharepoint application that needs to change web.config

I have a feature that is supposed to make all these configurations. The code for that feature is like this:

SPSite site = properties.Feature.Parent as SPSite;
List<SPWebConfigModification> modifications = new List<SPWebConfigModification>();
modifications.AddRange(CustomErrorsModeConfig.Modifications);
webConfigModificationHelper.AddWebConfigModifications(site.WebApplication, modifications);

CustomErrorsModeConfig.Modifications property contains this code:

public static SPWebConfigModification[] Modifications = {
new SPWebConfigModification()
{ 
Owner = WebConfigModificationOwner,
Name = "mode",
Type = SPWebConfigModification.SPWebConfigModificationType.EnsureAttribute, 
Path = "system.web/customErrors",
Sequence = 0,
Value = "Off"
}
};

Then finally the webConfigModificationHelper.AddWebConfigModifications method:

foreach (SPWebConfigModification modification in modifications)
{
webApp.WebConfigModifications.Add(modification);
}
webApp.Farm.Services.GetValue<SPWebService>().ApplyWebConfigModifications();
webApp.Update();

The problem is that I keep getting this error:

Name cannot begin with the ''' character, hexadecimal value 0x27. Line 1, position 1453

Could this be a problem with the web.config before I try to apply my changes ?

Could the SPWebConfigModification property be incorrectly defined ?

Is there some glitch in my code that leads to this error ?

Might there be some property I am missing (e.g. web.AllowUnsafeUpdates) ?

Some sharepoint site configuration ?

I've been trying to solve this issue for some time now with no luck 🙁 Any ideas ?

Best Answer

I can recommend using stsadmwebconfig for making changes to web.config files. I've implemented this in many features and it has always been a pain, especially while developing. Using this tool makes it a lot easier.

Related Solutions

C# – Should ‘using’ directives be inside or outside the namespace

There is actually a (subtle) difference between the two. Imagine you have the following code in File1.cs:

// File1.cs
using System;
namespace Outer.Inner
{
    class Foo
    {
        static void Bar()
        {
            double d = Math.PI;
        }
    }
}

Now imagine that someone adds another file (File2.cs) to the project that looks like this:

// File2.cs
namespace Outer
{
    class Math
    {
    }
}

The compiler searches Outer before looking at those using directives outside the namespace, so it finds Outer.Math instead of System.Math. Unfortunately (or perhaps fortunately?), Outer.Math has no PI member, so File1 is now broken.

This changes if you put the using inside your namespace declaration, as follows:

// File1b.cs
namespace Outer.Inner
{
    using System;
    class Foo
    {
        static void Bar()
        {
            double d = Math.PI;
        }
    }
}

Now the compiler searches System before searching Outer, finds System.Math, and all is well.

Some would argue that Math might be a bad name for a user-defined class, since there's already one in System; the point here is just that there is a difference, and it affects the maintainability of your code.

It's also interesting to note what happens if Foo is in namespace Outer, rather than Outer.Inner. In that case, adding Outer.Math in File2 breaks File1 regardless of where the using goes. This implies that the compiler searches the innermost enclosing namespace before it looks at any using directive.

R – How to change SharePoint extended web application’s web.config file

I got an answer form a blog.

In your case , you need to write a Web Application scoped feature which after you provision your site using your C# app, it is deployed to the newly-provisioned site and in the receiver of the feature you inject the required web.config settings because in that context configuration API is obtainable , but again bear the following in mind:

If you don’t use SPWebConfigModification class and either use ASP.NET 2.0 configuration API or your own mechanism , propagating changes across the farm is YOUR RESPONSIBILITY. If this happens on an standalone installation then you don;t need to be worried about this.

So it cannot be done externally. We have to do a feature in order to acheve this.

Thanks

Best Answer

Related Solutions

C# – Should ‘using’ directives be inside or outside the namespace

R – How to change SharePoint extended web application’s web.config file

Related Topic