Lists.GetListItemChangesWithKnowledge method

  • Article

Returns all of the list items that meet specified criteria and that have changed since the date-time specified in the knowledge parameter for the specified list.

Namespace:  WebSvcLists
Assembly:  STSSOAP (in STSSOAP.dll)

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/GetListItemChangesWithKnowledge", RequestNamespace := "https://schemas.microsoft.com/sharepoint/soap/",  _
    ResponseNamespace := "https://schemas.microsoft.com/sharepoint/soap/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function GetListItemChangesWithKnowledge ( _
    listName As String, _
    viewName As String, _
    query As XmlNode, _
    viewFields As XmlNode, _
    rowLimit As String, _
    queryOptions As XmlNode, _
    syncScope As String, _
    knowledge As XmlNode, _
    contains As XmlNode _
) As XmlNode
'Usage
Dim instance As Lists
Dim listName As String
Dim viewName As String
Dim query As XmlNode
Dim viewFields As XmlNode
Dim rowLimit As String
Dim queryOptions As XmlNode
Dim syncScope As String
Dim knowledge As XmlNode
Dim contains As XmlNode
Dim returnValue As XmlNode

returnValue = instance.GetListItemChangesWithKnowledge(listName, _
    viewName, query, viewFields, rowLimit, _
    queryOptions, syncScope, knowledge, _
    contains)

[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/GetListItemChangesWithKnowledge", RequestNamespace = "https://schemas.microsoft.com/sharepoint/soap/", 
    ResponseNamespace = "https://schemas.microsoft.com/sharepoint/soap/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public XmlNode GetListItemChangesWithKnowledge(
    string listName,
    string viewName,
    XmlNode query,
    XmlNode viewFields,
    string rowLimit,
    XmlNode queryOptions,
    string syncScope,
    XmlNode knowledge,
    XmlNode contains
)

Parameters

  • listName
    Type: System.String

    The GUID or the list title of the list from which to retrieve list items. If the specified list is the user information list, the string is set to "UserInfo" or "User Information list".

  • viewName
    Type: System.String

    The GUID of the view of the list from which to return list items. If not specified, the default list view is used. viewFields, rowLimit, and queryOptions parameters, if specified, must override corresponding attributes of the view used. Note that clients should not use this parameter. If specified, the server must ignore this parameter if the viewFields parameter is also specified; otherwise, the server must only validate that this parameter is both a valid GUID and that the parameter refers to a view of the list.

  • query
    Type: System.Xml.XmlNode

    Query to determine which records from the list are to be returned and the order in which they will be returned.

  • viewFields
    Type: System.Xml.XmlNode

    Specifies which fields of the list item should be returned. If not specified, whether by excluding the parameter or by including a a null reference (Nothing in Visual Basic) value, the fields defined for the viewName parameter view are used. If the Properties attribute of the ViewFields structure is set to true and the MetaInfo field is referenced in a FieldRef parameter, then properties related to the list must be returned with the prefix "ows_MetaInfo_".

  • rowLimit
    Type: System.String

    Specifies the maximum number of rows of data to return in the response. If not specified, whether by passing an empty element or by excluding the element, the default row limit for the view specified by the viewName parameter is used. Otherwise, this must be a 32-bit unsigned integer. The server must not return more list items than specified by this parameter.

  • queryOptions
    Type: System.Xml.XmlNode

    Specifies options that are available to modify the query

  • syncScope
    Type: System.String

    Specifies the scope of the synchronization. If a null reference (Nothing in Visual Basic), the default sync scope is used with an empty identifier.

  • knowledge
    Type: System.Xml.XmlNode

    Specifies the Microsoft Sync Framework knowledge data structure in XML format. If not provided by the client, all items in the list are returned, subject to the default row limit of the view or the overriding rowLimit parameter. If specified, the response will include changes made to list items after the knowledge was retrieved, subject to the row limit restrictions.

  • contains
    Type: System.Xml.XmlNode

    Restricts the results returned by giving a specific value to be searched for in the specified list item field. The server returns only those list items satisfying this criteria.

Return value

Type: System.Xml.XmlNode
Returns a XmlNode object representing list item changes as well as item knowledge.

See also

Reference

Lists class

Lists members

WebSvcLists namespace