SPList.GetDataTable Method

Retrieves a data table that contains item data that satisfies a query.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No
Available in SharePoint Online

Syntax

'Declaration
<SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.ShimmedTypeOutParam)> _
Public Function GetDataTable ( _
    query As SPQuery, _
    flags As SPListGetDataTableOptions, _
    <OutAttribute> ByRef position As SPListItemCollectionPosition _
) As DataTable
'Usage
Dim instance As SPList
Dim query As SPQuery
Dim flags As SPListGetDataTableOptions
Dim position As SPListItemCollectionPosition
Dim returnValue As DataTable

returnValue = instance.GetDataTable(query, _
    flags, position)

[SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.ShimmedTypeOutParam)]
public DataTable GetDataTable(
    SPQuery query,
    SPListGetDataTableOptions flags,
    out SPListItemCollectionPosition position
)

Parameters

• query
  Type: Microsoft.SharePoint.SPQuery

  The query that will be used to select data. Only the fields that are specified in the query are returned.

• flags
  Type: Microsoft.SharePoint.SPListGetDataTableOptions

  An enumeration value that specifies options for populating the data table with the values of fields in list items.

• position
  Type: Microsoft.SharePoint.SPListItemCollectionPosition

  A reference to an object that will receive paging information.

Return Value

Type: System.Data.DataTable
A data table that contains the result of the query. Each row in the table represents a list item that satisfies the query. Each column represents a field that was specified in the query.

Exceptions

Exception	Condition
ArgumentNullException	The query parameter is a null reference。

See Also

Reference

SPList Class

SPList Members

Microsoft.SharePoint Namespace

GetDataTable()

GetItems(SPQuery)

AppendDataTable(SPQuery, SPListGetDataTableOptions, DataTable, SPListItemCollectionPosition)

SPListItemCollectionPosition