SPListCollection.GetList Method (Guid, Boolean, Boolean, Boolean)
Returns the list with the specified GUID from the collection, including metadata for views and forms, security data, and related fields.
Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online
Syntax
'Declaration
Public Function GetList ( _
uniqueId As Guid, _
fetchMetadata As Boolean, _
fetchSecurityData As Boolean, _
fetchRelatedFields As Boolean _
) As SPList
'Usage
Dim instance As SPListCollection
Dim uniqueId As Guid
Dim fetchMetadata As Boolean
Dim fetchSecurityData As Boolean
Dim fetchRelatedFields As Boolean
Dim returnValue As SPList
returnValue = instance.GetList(uniqueId, _
fetchMetadata, fetchSecurityData, _
fetchRelatedFields)
public SPList GetList(
Guid uniqueId,
bool fetchMetadata,
bool fetchSecurityData,
bool fetchRelatedFields
)
Parameters
uniqueId
Type: System.GuidThe GUID for the list to return.
fetchMetadata
Type: System.Booleantrue to retrieve metadata for the views and forms of the list; otherwise, false.
fetchSecurityData
Type: System.Booleantrue to retrieve security data for the list; otherwise, false.
fetchRelatedFields
Type: System.Booleantrue to retrieve related fields for this list; otherwise, false. For more information, see Custom Related Fields.
Return Value
Type: Microsoft.SharePoint.SPList
An object that represents the list.
Exceptions
Exception | Condition |
---|---|
SPException | The GUID passed as an argument to the uniqueId parameter is invalid. |