Lists.GetListItems-Methode

Artikel
05/06/2015

Gibt Informationen zu Elementen in der Liste auf der Grundlage der angegebenen Abfrage zurück.

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

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/GetListItems", RequestNamespace := "https://schemas.microsoft.com/sharepoint/soap/",  _
    ResponseNamespace := "https://schemas.microsoft.com/sharepoint/soap/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Function GetListItems ( _
    listName As String, _
    viewName As String, _
    query As XmlNode, _
    viewFields As XmlNode, _
    rowLimit As String, _
    queryOptions As XmlNode, _
    webID As String _
) 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 webID As String
Dim returnValue As XmlNode

returnValue = instance.GetListItems(listName, _
    viewName, query, viewFields, rowLimit, _
    queryOptions, webID)

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

Parameter

listName
Typ: System.String

Eine Zeichenfolge, die den Anzeigenamen oder die GUID für die Liste enthält. Es wird empfohlen, die GUID verwenden, die in geschweiften Klammern ({}) eingeschlossen werden müssen. Beim Abfragen der UserInfo-Tabelle enthält die Zeichenfolge "UserInfo".

viewName
Typ: System.String

Eine Zeichenfolge, die die GUID für die Ansicht, umgeben von geschweiften Klammern ({}) die Ansicht enthält, mit der für die durch den Parameter query, viewFieldsund rowLimit dargestellte Ansicht Standardattribute bestimmt. Wenn dieser Parameter auf eine leere Zeichenfolge enthält, wird die Standardansicht verwendet. Wenn die Ansichts-GUID angegeben wird, überschreibt den Wert des Parameters query, viewFieldsoder rowLimit die entsprechende Einstellung in der Ansicht. Beispielsweise werden Wenn vom viewFields -Parameter angegebene Ansicht eine Zeile Grenze von 100 Zeilen, aber der Parameter rowLimit 1000 enthält, klicken Sie dann 1.000 Zeilen in der Antwort zurückgegeben.

query
Typ: System.Xml.XmlNode

Eine Query -Element mit der Abfrage, der bestimmt, welche Datensätze zurückgegeben und in Was sind Reihenfolge und, kann ein System.Xml.XmlNode -Objekt, wie im folgenden Beispiel zugewiesen werden.

viewFields
Typ: System.Xml.XmlNode

Ein ViewFields -Element, das gibt an, welche Felder in der Abfrage und in welcher Reihenfolge zurückgegeben und ein System.Xml.XmlNode -Objekt, wie im folgenden Beispiel zugewiesen werden können.

rowLimit
Typ: System.String

Eine Zeichenfolge, die Anzahl der Elemente oder Zeilen, die auf einer Seite angezeigt werden soll, vor Beginn der Auslagerungsdatei angibt. Wenn angegeben, überschreibt den Wert dieses Parameters den Grenzwert der Zeile in der durch den viewName -Parameter angegebenen Ansicht oder den Grenzwert der Zeile in der Standardansicht für die Liste.

queryOptions
Typ: System.Xml.XmlNode

Ein XML-Fragment in der folgenden Form, das separate Knoten für die verschiedenen Eigenschaften des SPQuery -Objekts enthält, und ein System.Xml.XmlNode -Objekt zugewiesen werden können.

webID
Typ: System.String

Optional. Eine Zeichenfolge mit der GUID der übergeordneten Website für die Liste, umgeben von geschweiften Klammern ({}). Wenn dieser Parameter auf ein Nullverweis (Nothing in Visual Basic) bedeutet, dass die durch die Url angegebenen Website-Eigenschaft des Diensts verwendet werden und wenn die Url -Eigenschaft des Diensts nicht angegeben ist, wird im Stammverzeichnis der Website verwendet werden.

Rückgabewert

Typ: System.Xml.XmlNode
Ein XML-Fragment in der folgenden Form, die Informationen über die Listenelemente enthält und ein System.Xml.XmlNode -Objekt zugewiesen werden können.

<listitems xmlns:s="uuid:BDC6E3F0-6DA3-11d1-A2A3-00AA00C14882" 
   xmlns:dt="uuid:C2F41010-65B3-11d1-A29F-00AA00C14882" 
   xmlns:rs="urn:schemas-microsoft-com:rowset" xmlns:z="#RowsetSchema" 
   xmlns="https://schemas.microsoft.com/sharepoint/soap/">
   <rs:data ItemCount="4">
      <z:row ows_Number_Field="6555.00000000000" 
         ows_Created="2003-06-18T03:41:09Z" 
         ows_ID="3" ows_owshiddenversion="3" />
      <z:row ows_Number_Field="78905456.0000000" 
         ows_Created="2003-06-18T17:15:58Z" 
         ows_ID="4" ows_owshiddenversion="2" />
         ...
   </rs:data>
</listitems>

Hinweise

Die GetListItems -Methode unterstützt das serverseitige Paging. Die von dieser Methode zurückgegebenen XML-Daten enthält ein ListItemCollectionPositionNext -Attribut innerhalb des rs:Data -Elements, das die Informationen zur Unterstützung des Paging enthält. Diese Zeichenfolge enthält Daten für die Felder in der Sortierung und andere Elemente für Paging erforderlich ist. Sie sollten diese Zeichenfolge interne und nicht geändert werden soll; ändern es kann unerwartete Ergebnisse liefern. Das folgende Beispiel zeigt das Formular von dieser Rückgabewert beim Paging unterstützt wird.

<rs:Data ListItemCollectionPositionNext=" 
Paged=TRUE&p_ID=100&View=
      %7bC68F4A6A%2d9AFD%2d406C%2dB624%2d2CF8D729901E%7d&PageFirstRow=
      101" Count=1000 >
   <z:row ows_FirstName="Nancy" ows_LastName="Name" ….. />
   ...
</rs:Data>

Wenn die nächste Seite mit Daten erhalten möchten, wird der Parameter queryOption verwendet, wie im folgenden Beispiel dargestellt.

<QueryOptions>
  <Paging ListItemCollectionPositionNext=" 
    Paged=TRUE&p_ID=100&View=
    %7bC68F4A6A%2d9AFD%2d406C%2dB624%2d2CF8D729901E%7d&PageFirstRow=
   101" />
</QueryOptions>

Beispiele

Im folgenden Codebeispiel wird angezeigt, in dem ein Number Feld enthält einen Wert größer als 5.000 und ein DateTime Feld enthält einen Wert größer als ein angegebenes Datum, Elemente. Im Beispiel wird ein XmlDocument -Objekt zum Erstellen von XmlNode -Objekten für Parameter verwendet.

Dieses Beispiel erfordert eine using (Visual c#) oder Imports (Visual Basic)-Direktive für den Namespace System.Xml eingeschlossen werden.

Dim listService As New Web_Reference_Folder.Lists()
listService.Credentials = System.Net.CredentialCache.DefaultCredentials

Dim xmlDoc = New System.Xml.XmlDocument()

Dim ndQuery As XmlNode = 
    xmlDoc.CreateNode(XmlNodeType.Element, "Query", "")
Dim ndViewFields As XmlNode = 
    xmlDoc.CreateNode(XmlNodeType.Element, "ViewFields", "")
Dim ndQueryOptions As XmlNode = 
    xmlDoc.CreateNode(XmlNodeType.Element, "QueryOptions", "")

ndQueryOptions.InnerXml = 
    "<IncludeMandatoryColumns>FALSE</IncludeMandatoryColumns>" + _
    "<DateInUtc>TRUE</DateInUtc>"
ndViewFields.InnerXml = 
    "<FieldRef Name='Field1'/><FieldRef Name='Field2'/>"
ndQuery.InnerXml = 
    "<Where><And><Gt><FieldRef Name='Field1'/>" + _
    "<Value Type='Number'>5000</Value></Gt><Gt>
        <FieldRef Name='Field2'/>" + _
    "<Value Type='DateTime'>2003-07-03T00:00:00</Value></Gt></And></Where>"

Try

    Dim ndListItems As XmlNode = 
        listService.GetListItems("List_Name", Nothing, ndQuery, _
        ndViewFields, Nothing, ndQueryOptions, Nothing)

    MessageBox.Show(ndListItems.OuterXml)

    Catch ex As System.Web.Services.Protocols.SoapException

        MessageBox.Show("Message:" + ControlChars.Lf + ex.Message + 
            ControlChars.Lf + 
        "Detail:" + ControlChars.Lf + ex.Detail.InnerText + 
            ControlChars.Lf + 
        "StackTrace:" + ControlChars.Lf + ex.StackTrace)

End Try

Web_Reference_Folder.Lists listService = new Web_Reference_Folder.Lists();
listService.Credentials= System.Net.CredentialCache.DefaultCredentials;

XmlDocument xmlDoc = new System.Xml.XmlDocument();

XmlNode ndQuery = xmlDoc.CreateNode(XmlNodeType.Element,"Query","");
XmlNode ndViewFields = 
    xmlDoc.CreateNode(XmlNodeType.Element,"ViewFields","");
XmlNode ndQueryOptions = 
    xmlDoc.CreateNode(XmlNodeType.Element,"QueryOptions","");

ndQueryOptions.InnerXml = 
    "<IncludeMandatoryColumns>FALSE</IncludeMandatoryColumns>" + 
    "<DateInUtc>TRUE</DateInUtc>";
ndViewFields.InnerXml = "<FieldRef Name='Field1' />
    <FieldRef Name='Field2'/>";
ndQuery.InnerXml = "<Where><And><Gt><FieldRef Name='Field1'/>" + 
    "<Value Type='Number'>5000</Value></Gt><Gt><FieldRef Name='Field2'/>" + 
    "<Value Type=
        'DateTime'>2003-07-03T00:00:00</Value></Gt></And></Where>";
try
{
    XmlNode ndListItems = 
        listService.GetListItems("List_Name", null, ndQuery, 
        ndViewFields, null, ndQueryOptions, null);
    MessageBox.Show(ndListItems.OuterXml);
}

catch (System.Web.Services.Protocols.SoapException ex)
{
    MessageBox.Show("Message:\n" + ex.Message + "\nDetail:\n" + 
        ex.Detail.InnerText + 
         "\nStackTrace:\n" + ex.StackTrace);
}

Siehe auch

Referenz

Lists Klasse

Lists-Member

WebSvcLists-Namespace

Freigeben über