Expand Minimize

Close PublishingWeb created by PublishingWeb.GetPublishingWebs[] index operator

The GetPublishingWebs method of the PublishingWeb class returns a PublishingWebCollection object. You must call the Close method on each enumerated innerPubWeb object. When you are calling only the GetPublishingWeb method, you are not required to call Close.

CheckId SPC110261
TypeName ClosePublishingWebCreatedByPublishingWebGetPublishingWebsIndex
Severity CriticalWarning
Type Assembly

The GetPublishingWebs method of the PublishingWeb class returns a PublishingWebCollection object. You must call the Close method on each enumerated innerPubWeb object. When you are calling only the GetPublishingWeb method, you are not required to call Close. See sample from MSDN:
Bad Practice

void PublishingWebCollectionLeak()
{
  using (SPSite siteCollection = new SPSite("http://moss"))
  {
    using (SPWeb web = siteCollection.OpenWeb())
    {
      // Passing in SPWeb object that you own, no dispose needed on
      // outerPubWeb.
      PublishingWeb outerPubWeb = PublishingWeb.GetPublishingWeb(web);
      
      PublishingWebCollection pubWebCollection = outerPubWeb.GetPublishingWebs();
      foreach (PublishingWeb innerPubWeb in pubWebCollection)
      {
        // innerPubWeb leak.
      }
      // PublishingWeb will leak for each innerPubWeb referenced
    } // SPWeb object web.Dispose() automatically called.
  } // SPSite object siteCollection.Dispose() automatically called.
}

Good Practice
void PublishingWebCollectionNoLeak()
{
  using (SPSite siteCollection = new SPSite("http://moss"))
  {
    using (SPWeb web = siteCollection.OpenWeb())
    {
      // Passing in SPWeb object that you own, no dispose needed on
      // outerPubWeb.
      PublishingWeb outerPubWeb = PublishingWeb.GetPublishingWeb(web);
      PublishingWebCollection pubWebCollection = outerPubWeb.GetPublishingWebs();
      foreach (PublishingWeb innerPubWeb in pubWebCollection)
      {
        try
        {
          // ...
        }
        finally
        {
          if(innerPubWeb != null)
            innerPubWeb.Close();
        }
      }
    }  // SPWeb object web.Dispose() automatically called.
  } // SPSite object siteCollection.Dispose() automatically called.
}

Rule relates to SPDisposeCheckId 'SPDisposeCheckID_300'. To ignore this rule add the attribute '[SPDisposeCheckIgnore(SPDisposeCheckID.SPDisposeCheckID_300, "Caller will dispose")]' to your method.

To suppress this violation in managed code add the following attribute to the method which contains the instruction (available since SPCAF version v5.2). Learn more about SuppressMessage here.

// Important: Ensure to have #define CODE_ANALYSIS at the beginning of your .cs file
[SuppressMessage("SPCAF.Rules.MemoryDisposalGroup", "SPC110261:ClosePublishingWebCreatedByPublishingWebGetPublishingWebsIndex", Justification = "Provide reason for suppression here")]
Disclaimer: The views and opinions expressed in this documentation and in SPCAF do not necessarily reflect the opinions and recommendations of Microsoft or any member of Microsoft. SPCAF and RENCORE are registered trademarks of Rencore. All other trademarks, service marks, collective marks, copyrights, registered names, and marks used or cited by this documentation are the property of their respective owners.