SPC050238: Do not call SPWeb.GetListFromUrl. Use SPWeb.GetListFromWebPartPageUrl instead. |
SPWeb.GetListFromUrl gets the list that is associated with the first Web Part on the specified Web Parts page. Beginning in Windows SharePoint Services 3.0, use the GetListFromWebPartPageUrl method instead of this method.
| CheckId | SPC050238 |
|---|---|
| TypeName | DoNotUseSPWebGetListFromUrl |
| Severity | CriticalWarning |
| Type | Assembly |
Replace calls to SPWeb.GetListFromUrl with SPWeb.GetListFromWebPartPageUrl.
Bad Practice
SPWeb myWeb = SPContext.Current.Web;
SPList myList = web.GetListFromUrl("/sites/sitecollection/subsite/default.aspx");
Good Practice
SPList myList = web.GetListFromUrl("/sites/sitecollection/subsite/default.aspx");
SPWeb myWeb = SPContext.Current.Web;
SPList myList = web.GetListFromWebPartPageUrl("/sites/sitecollection/subsite/default.aspx");
SPList myList = web.GetListFromWebPartPageUrl("/sites/sitecollection/subsite/default.aspx");
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.BestPracticesGroup", "SPC050238:DoNotUseSPWebGetListFromUrl", Justification = "Provide reason for suppression here")]
[SuppressMessage("SPCAF.Rules.BestPracticesGroup", "SPC050238:DoNotUseSPWebGetListFromUrl", 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 AB. 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.