SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

MSDN Blog Postings » SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

MSDN Blog Postings » SharePoint 2007 and WSS 3.0 Dispose Patterns by Example — Wed, 13 Feb 2008 06:00:08 GMT

PingBack from http://msdnrss.thecoderblogs.com/2008/02/12/sharepoint-2007-and-wss-30-dispose-patterns-by-example/

Link Listing - February 12, 2008

Christopher Steen — Wed, 13 Feb 2008 16:35:42 GMT

Sharepoint SharePoint 2007 and WSS 3.0 Dispose Patterns by Example [Via: Roger Lamb ] WPF WPF 3.5 Data...

Roger joins the fray ... w00t!

Don Smith — Wed, 13 Feb 2008 20:38:53 GMT

My good friend Roger Lamb has just joined the blogsphere and I assure you that if you are interested

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

arangas — Thu, 14 Feb 2008 18:17:15 GMT

Hi Roger,

This article is a good reference as it covers more than the MSDN best practices article. It would be great to see this post updated as you think of more information. I noticed that you don't mention (not) disposing when using SPContext, which would be a good addition (and what about cases such as SPContext.Current.Site.RootWeb?). Using the ULS logs to find which parts of your code aren't disposing correctly would be great too.

Thanks again, Alex.

Welcome Roger Lamb to the blog space

Steve Sheppard's Blog — Fri, 15 Feb 2008 20:45:25 GMT

For his first post he has provided a bunch of examples of dispose patterns for SharePoint that will be

Welcome Roger Lamb to the blog space

Noticias externas — Fri, 15 Feb 2008 20:53:04 GMT

For his first post he has provided a bunch of examples of dispose patterns for SharePoint that will be

SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

Miguel Isidoro — Wed, 20 Feb 2008 23:35:24 GMT

When developing for the SharePoint platform, developers should be very careful in using the SharePoint

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

MaximeB — Thu, 21 Feb 2008 19:38:49 GMT

Very good job detailing a lot more the default principles on disposing objects.

Maxime

Gestion du Dispose : Attention au Memory Pressure sous SharePoint (et donc comment faire mieux)

The Mit's Blog — Mon, 25 Feb 2008 18:19:18 GMT

Un post qui vient un poil en doublon de ceux qui relaye 2 nouveaux articles de blog mais ces posts sont

WSS 3.0 & MOSS: Recopilación de enlaces interesantes XV

Blog del CIIN — Tue, 26 Feb 2008 03:00:33 GMT

Hacía tiempo que no revisaba mis RSS sobre SharePoint , y claro me ha costado ponerme al día, y aquí

SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

Mirrored Blogs — Wed, 05 Mar 2008 09:02:04 GMT

A very good article about Sharepoint 2007 and WSS 3.0 Dispose Patterns: Roger Lamb's SharePoint Developer

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

bazztrap — Mon, 24 Mar 2008 18:26:48 GMT

Basically any new instance has to be disposed, I am curious about objects which are referenced from different events like EvenHandler properties properties.OpenWeb()

SharePoint Kaffeetasse #51

Mirrored Blogs — Tue, 01 Apr 2008 10:44:18 GMT

Tipps Sending alerts to groups in Sharepoint 2007 SharePoint 2007 Permissions Matrix What is ReGhost

Memory Leak in SPLimitedWebPartManager (a.k.a. IDisposables Containing IDisposables)

Random Musings of Jeremy Jameson — Wed, 09 Apr 2008 21:45:03 GMT

Back in February, Roger Lamb kicked off his MSDN blog with a great post ( SharePoint 2007 and WSS 3.0

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

rlasker3 — Thu, 17 Apr 2008 16:54:38 GMT

I also want to know about the SPFeature.Parent. I have seen arguments either way and would prefer something a little definitive.

SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

SaurabhKV — Tue, 06 May 2008 10:03:28 GMT

When writing customized SharePoint code you need to be aware of the scope and context of each SPSite

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

buzza — Sat, 10 May 2008 06:18:31 GMT

Microsoft.SharePoint.SPList.BreakRoleInheritance.

Consider this:

To get a SPList object, you need to have a SPWeb object (is there any other way?), wouldn't that be the same (reference as well) as the SPList.ParentWeb object. Now if this SPWeb object came from the current context then it should not be disposed. If the SPWeb object was not created by the current context then it should be disposed.

using (SPSite mySite = new SPSite("http://server"))

using (SPWeb myWeb = mySite.OpenWeb())

{

SPList myList = myWeb.Lists[0];

// is myList.ParentWeb always the same reference as myWeb

// if not - what circumstances is it not.

// if so - parentweb is disposed with the using statement

}

Are we sure we need to dispose SPList.ParentWeb ???

Is this correct ??

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

Stian Kirkeberg — Fri, 16 May 2008 10:31:10 GMT

Great article, Robert! Thank you.

What do you think should be the best way to handle a situation like this:

using (SPSite mySite = new SPSite("http://server"))

using (SPWeb myWeb = mySite.OpenWeb())

{

myMethod(myWeb);

}

private void myMethod(SPWeb web)

{

// work with the web object

// should dispose be called? What about the reference copy on the stack?

}

And situation 2:

private void myMethod(SPWeb web)

{

// work with the web object

mySite.OpenWeb()) // then open another web....

// call dispose.

}

Do you agree? Or can you suggest another pattern to avoid these situations?

Thanks

SharePoint 2007 : Extension Method (DeleteAllItems)

Philippe Sentenac [MVP SharePoint] — Tue, 20 May 2008 11:03:08 GMT

Après vous avoir parlé de ce que l'on pouvait faire avec les extensions de méthodes et un peu de réflection,

Troubleshooting SPSite/SPWeb leaks in WSS v3 and MOSS 2007

Shared Points for SharePoint... — Wed, 28 May 2008 08:58:51 GMT

Stefan Gossner has published a great article on the subject: In an earlier article I have discussed that

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

sergioko — Thu, 29 May 2008 11:07:24 GMT

Does MS have a plan to close any of this leaks like in BreakRoleInheritance() internally? What happens to our perfect existing code, if next MOSS/WSS service pack will invent a proper dispose of ParentWeb in there? Double disposal?

Asignación CAS de Sharepoint por contexto de usuario

Mario Cortés Flores — Wed, 04 Jun 2008 01:00:30 GMT

Puesta en situación En uno de nuestros proyectos hemos tenido que manejar el contexto del usuario en

Оптимизация кода 2

First Hand — Tue, 17 Jun 2008 15:41:34 GMT

Источник...Смысл в том, чтобы уничтожать объекты SPweb, SPSite и т.п. методом Dispose() принудительно....

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

ajayrsawant — Sun, 22 Jun 2008 11:22:16 GMT

We have code where at times we'll be returning an SPWeb object from a function. So for example:

public SPWeb getDeptWeb()

{

SPWeb deptWeb = SpSite.OpenWeb(SpContext.Web.ID);

...

return deptWeb;

}

How can we dispose of the SPWeb object in this instance? Or is it sufficient to dispose it where we're accepting the returned parameter?

Programmierung: Potentielle Memory-Leaks bei SPSite und SPWeb

Meine SharePoint-Notizen — Thu, 10 Jul 2008 13:45:22 GMT

Beim Programmieren im SharePoint-Umfeld sollte man großen Wert auf saubere und sicherer Programmierung

Üks asjalik Sharepointi postitus Dispose -i teemal

Iga lahendus tekitab uusi probleeme ehk alati võib leida veel ühe bugi. — Mon, 11 Aug 2008 00:52:17 GMT

Maailmas on palju blogijaid ja nende heade ning väärtuslike postituste leidmine ei ole alati lihtne ega

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

miguel.isidoro@create.pt — Mon, 15 Sep 2008 19:33:10 GMT

Hello Roger,

A few remarks on your post. I think it is great and covers a large amount of situations. Two types of situations I noticed are not covered:

Workflows:

workflowProperties.Web, workflowProperties.Site and workflowProperties.Item.Web don't need to be disposed.

Event handlers:

properties.ListItem.Web

properties.ListItem.Web.Site

About these two, I am not sure if they need to be disposed. Do you know if these need to be disposed?

Thanks

Miguel

MSDN Link: SharePoint Best Practices - Disposing WSS Objects

SPSherm.MyBlog — Tue, 16 Sep 2008 23:22:12 GMT

Might as well dive right in and make the inaugural posting useful... Anyone who's done some development

Best Practices: Using Disposable Windows SharePoint Services Objects

SharePoint — Mon, 22 Sep 2008 10:03:28 GMT

The URL given below takes you to an very useful article which describes the appropriate ways to write your code when using Microsoft Windows SharePoint Services objects so that you can avoid retaining the objects in memory with the Microsoft .NET Framework.

SharePoint Performance optimizations

Marwan Tarek's blog [MVP SharePoint] — Wed, 24 Sep 2008 11:28:48 GMT

Performance is perspective that all the developers forget during development and it pops up and the end

SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

laputa'sky — Thu, 25 Sep 2008 17:11:51 GMT

from:http://blogs.msdn.com/rogerla/archive/2008/02/12/sharepoint-2007-and-wss-3-0-dispose-patterns-b...

SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

laputa'sky — Thu, 25 Sep 2008 17:26:57 GMT

from:http://blogs.msdn.com/rogerla/archive/2008/02/12/sharepoint-2007-and-wss-3-0-dispose-patterns-b...

Utilizar "Dispose()" correctamente en MOSS 2007

Mirrored Blogs — Wed, 15 Oct 2008 15:08:03 GMT

He encontrado esta página donde nos explican la manera correcta de utilizar el Dispose() cuando accedemos

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

Sven De Bont — Tue, 21 Oct 2008 22:44:59 GMT

Excellent article!

Got us through a very annoying 'OutOfMemeryExcepton' when modifying a webpart page in 6000 childwebs (the culprit was the SPLimitedWebPartManager)

Best Practices - SharePoint Object Model for Performance Tuning

Sowmyan's SharePoint Developer Blog — Sun, 26 Oct 2008 14:30:36 GMT

I am writing this post by inspired by couple of performance related cases that I had been worked with

Disposal of objects in WSS and SharePoint 2007

sdbonline.com — Thu, 30 Oct 2008 09:08:21 GMT

Disposal of objects in WSS and SharePoint 2007

Getting To the Root (Well Almost) - Navigating the SPWeb Hierarchy

Adventures in Consulting — Wed, 12 Nov 2008 01:13:36 GMT

Recently I was faced with the problem of finding an ancestor web (SPWeb object) of the current web. The

Moss 2007 dispose issues, don't be a the victim

Rick's BizTalk Debugging, Troubleshooting Tips and Experiences — Thu, 13 Nov 2008 21:39:59 GMT

SPDisposeCheck tool officially announced Last year I leveraged a good friend and coworker (Roger Lamb)

手动释放spsite和spweb

天使の泪 — Mon, 17 Nov 2008 13:42:26 GMT

from:RogerLamb

http://blogs.msdn.com/rogerla/archive/2008/02/12/sharepoint-2007-and-wss-3-0-dispo...

SharePoint - The New Oracle

Andreas Zenker — Thu, 08 Jan 2009 05:01:17 GMT

I was posting a WPF question on stackoverflow and I took a few minutes to tie up loose ends on a question

When to Dispose SharePoint objects

Confluence: SharePoint Development Wiki — Thu, 15 Jan 2009 11:08:58 GMT

SPSite and SPWeb implement the IDisposable interface

SPDisposeCheck v1.3.1 is released

Paul Andrew — Thu, 29 Jan 2009 20:46:19 GMT

SPDisposeCheck is a tool to help SharePoint Developers follow memory management best practices when using

Outil : SPDisposeCheck est disponible

Blog Tech — Fri, 30 Jan 2009 00:33:20 GMT

Outil : SPDisposeCheck est disponible

SPDisposeCheck liberado en MSDN Code Gallery!

Blog del CIIN — Fri, 30 Jan 2009 01:23:09 GMT

Tal y como nos comenta Paul Andrew en este post , Microsoft acaba de liberar en MSDN Code Gallery la

SharePoint 2007 : Dispose Patterns et l'outil SPDisposeCheck

Philippe Sentenac [MVP SharePoint] — Fri, 30 Jan 2009 11:41:41 GMT

[via Paul Andrew ] SPDisposeCheck avait été présenté dernièrement sur le blog de l'équipe SharePoint

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

m_3ryan — Fri, 30 Jan 2009 16:01:44 GMT

I thinks the best practice on this article is to use the object Microsoft.SharePoint.WebControls.SPControl and get rid of thinking about disposing again.

Automate SharePoint Dispose() code reviews with SPDisposeCheck

Roger Lamb's SharePoint Developer Blog — Sat, 31 Jan 2009 02:15:32 GMT

Today the Microsoft SharePoint Product Team announced the SPDisposeCheck utility here and also at Paul

SPDisposeCheck Tool Public Release

Mirrored Blogs — Tue, 03 Feb 2009 14:19:52 GMT

Body: I've been eagerly awaiting the public release of the SP Dispose Check Tool and now its available

SPDisposeCheck – Fakty i Akty :)

.neting in the free world — Tue, 03 Feb 2009 17:08:47 GMT

SPDisposeCheck jest już od paru dni dostępny , i muszę powiedzieć, że tool mi się podoba – choć mam wrażenie

Links for today (2009.02.04)

My.Mountains[] — Wed, 04 Feb 2009 12:54:01 GMT

New Tech Meetup Birthday & Pecha Kucha Night MS Rampup - SharePoint for Developers Track –

Best Practice en el desarrollo con Sharepoint

Mario Cortés Flores — Thu, 12 Feb 2009 01:52:47 GMT

Hay una cosa que tenemos que tener clara y es que Sharepoint no deja de ser un producto más o menos cerrado

SPDisposeCheck - Fakty i Akty :)

.neting in the free world — Mon, 16 Feb 2009 13:11:10 GMT

SPDisposeCheck jest już od paru dni dostępny , i muszę powiedzieć, że tool mi się podoba – choć mam wrażenie

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

RichardWillis — Fri, 27 Feb 2009 03:00:19 GMT

I'm the project co-ordinator for the SharePoint Learning Kit at http://www.codeplex.com/slk. As it's a great tool, I'd love to use SPDisposeCheck on it, but it checks to see if the file name begins with Microsoft (it does) and then if I rename the file, if any namespace begins with Microsoft (they all do) and then skips the assembly. Is there any possibility of adding an option to not skip Microsoft assemblies. And before you ask, we can't change the namespaces as it was originally a Microsoft project and it would break all existing installations.

Thanks,

Richard

TechDays 2009 - Enhancing the SharePoint developer experience - Supporting links

Microsoft RealDolmen blogs — Wed, 11 Mar 2009 18:54:16 GMT

TechDays 2009 - Enhancing the SharePoint developer experience - Supporting links

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

sergioko — Wed, 11 Mar 2009 18:59:48 GMT

Hello Roger,

One more situation I noticed, when disposing does bad, and not disposing is probably bad too ;-)

In CreateChildControl() method of a webpart, I use this pattern to render a field of a list item from another web:

using (SPSite site = new SPSite("http://address"))

using (SPWeb web = site.OpenWeb())

{

...

BaseFieldControl c = field.FieldRenderingControl;

c.ItemContext = SPContext.GetContext(HttpContext.Current, item.ID, list.ID, web);

...

Controls.Add(c);

...

}

The problem is that the BaseFieldControl keeps a reference of the web object (through the ItemContext) and at its rendering stage the web has already been invalidated and exception says "List does not exist The page you selected contains a list that does not exist. It may have been deleted by another user.."

If I don't dispose site and web objects with that 'using' directive, everything works fine, but I'm afraid the memory going to leak somewhere... How can I control the disposing of context objects like this?

To Dispose or not to Dispose -- that is the question

Random Musings of Jeremy Jameson — Thu, 19 Mar 2009 16:38:00 GMT

Last Saturday, another team member sent an email out to the team inquiring about the "MOSS object disposal

SharePoint 2007 : SPDisposeCheck ne verifierait pas tout les patterns de dispose connus

Philippe Sentenac [MVP SharePoint] — Fri, 20 Mar 2009 12:43:59 GMT

[via Stephen Vick’s Blog ] Dans la série des nouvelles qui ne font pas plaisir, il semblerait que SPDisposeCheck

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

Dinesh Bolkensteyn — Tue, 07 Apr 2009 07:56:31 GMT

Hi Roger,

It would be cool if SPDisposeCheck could not only check for memory leaks, but also for invalid disposes (if case someone tries to free something that is part of the automagically SharePoint framework managed objects)

Of course there's SPContext, but from what Miguel Isidoro (see previous comment) said, it also includes workflows and list event handlers, and maybe even more.

Many thanks !

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

Roger Lamb — Tue, 07 Apr 2009 15:43:27 GMT

Hi Dinesh, I agree.. we are reviewing adding this feature to the approved list of 'do not dispose' mentioned in the msdn whitepaper and my blog.

[SharePoint 2007] La famille SharePointOfView s’agrandit : SharePoint FxCop Rules

Adrien Siffermann — Mon, 13 Apr 2009 11:53:58 GMT

[English version @ http://sovfxcoprules.codeplex.com ] Après : SharePointOfView , qui regroupe un ensemble

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

mpeyer — Wed, 15 Apr 2009 18:00:34 GMT

Hi Roger

I couldn't find an advice on how to deal with the Workflow Context object. I'm developing a custom SPD workflow action and there I retrieve the DependenyProperty __Context which is of type Microsoft.SharePoint.WorkflowActions.WorkflowContext. This object has a parameter Site and also Web and implements IDisplosable. Now I'm wondering if I have to dispose this WorkflowContext object by myself or not.

Regards, Marc

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

arangas — Fri, 24 Apr 2009 17:03:15 GMT

Roger, this might be an obvious one but what about SPWeb.Site to retrieve the current site collection for a web? It looks to me like this does not need to be disposed.

Thanks Alex.

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

arangas — Fri, 24 Apr 2009 17:06:51 GMT

Also, using the enumerator in SPListCollection causes a memory leak to be logged:

This SPRequest was allocated at at Microsoft.SharePoint.Library.SPRequest..ctor() at Microsoft.SharePoint.SPGlobal.CreateSPRequestAndSetIdentity(Boolean bNotGlobalAdminCode, String strUrl, Boolean bNotAddToContext, Byte[] UserToken, String userName, Boolean bIgnoreTokenTimeout, Boolean bAsAnonymous) at Microsoft.SharePoint.SPWeb.InitializeSPRequest() at Microsoft.SharePoint.SPWeb.EnsureSPRequest() at Microsoft.SharePoint.SPWeb.get_Request() at Microsoft.SharePoint.SPListCollection.EnsureListsData(Guid webId, String strListName) at Microsoft.SharePoint.SPListCollection.EnsureListsData(String strListName) at Microsoft.SharePoint.SPListCollection.Undirty() at Microsoft.SharePoint.SPBaseCollection.System.Collections.IEnumerable.GetEnumerator()

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

jarofkla — Thu, 28 May 2009 20:38:00 GMT

So what is the proper way to dispose in your Cross Method example? I've tried to use a class destructor to manage the dispose of the web and site, but it doesn't seem to work.

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

ritmeijer@hotmail.com — Thu, 20 Aug 2009 13:52:18 GMT

This is a great resource, as is the SPDisposeChecker tool. It appears you missed out SiteAdministrationSelector.CurrentItem though as well as disposing of streams that come of SPFile.

For details see

http://www.muhimbi.com/blog/2009/08/additional-little-known-sharepoint.html

and

http://www.muhimbi.com/blog/2009/07/solution-for-sharepoints-common.html

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

mikeycooper — Sun, 15 Nov 2009 12:23:08 GMT

The static methoc SPList.Exists seems to leak an SPSite. It uses "new SPSite" but then does not dispose of it.

re: SharePoint 2007 and WSS 3.0 Dispose Patterns by Example

mikeycooper — Sun, 15 Nov 2009 12:24:16 GMT

Sorry, that should be "The static method SPSite.Exists seems to leak an SPSite."