ISharePointListService.GetListItems Method

Gets a selection of items of a SharePoint list identified by its title. Keeping FieldName or FieldType unspecified causes all items (optionally restricted by QueryInnerXml) to be selected. Keeping QueryInnerXml unspecified causes all list items to be selected (the listItemsSelection still applies).

The listItemsSelection parameter is provided just for comfortability reason and produces a query similar to the following

            <Query>
                <And>
                    QueryInnerXml <Eq><FieldRef Name="FieldName" /><Value Type="FieldType">FieldValue</Value></Eq>
                </And>
            </Query>
            

The DataSet has an empty table (with no columns) if no list items are retrieved.

Namespace: CMS.SharePoint
Assembly: CMS.SharePoint (in CMS.SharePoint.dll) Version: 10.0.0

Syntax

DataSet GetListItems(
	string listTitle,
	string folderServerRelativeUrl = null,
	SharePointView view = null,
	SharePointListItemsSelection listItemsSelection = null
)

Parameters

listTitle

Type: System.String
SharePoint list title

folderServerRelativeUrl (Optional)

Type: System.String
Relative URL of listed folder (if list supports subfolders). Keep blank for root listing.

view (Optional)

Type: CMS.SharePoint.SharePointView
Configuration options for list items retrieval.

listItemsSelection (Optional)

Type: CMS.SharePoint.SharePointListItemsSelection
Constraint for selection of certain items.

Return Value

Type: DataSet
DataSet containing DataTable with list items.

Exceptions

Exception	Condition
SharePointServerException	Thrown whenever server error occurs.
WebException	Thrown when error related to network or protocol occurs.
SharePointConnectionNotSupportedException	Thrown when given connectionData contains unsupported authentication mode or invalid URL.
SharePointCCSDKException	Thrown when identity client library "msoidcliL.dll" needed for SharePoint Online authentication is missing. See documentation for details.
Exception	Thrown in case of unexpected error condition.

Remarks

The value of parameter folderServerRelativeUrl can originate from FileRef column of parent folder items listing. To determine whether an item is a folder, check the FSObjType column's value equality to 1.