ObjectQuery(Of T).Skip Method (String, String, ObjectParameter())

 

Orders the query results by the specified criteria and skips a specified number of results.

Namespace:   System.Data.Objects
Assembly:  System.Data.Entity (in System.Data.Entity.dll)

Public Function Skip (
	keys As String,
	count As String,
	ParamArray parameters As ObjectParameter()
) As ObjectQuery(Of T)

Parameters

keys
Type: System.String

The key columns by which to order the results.

count
Type: System.String

The number of results to skip. This must be either a constant or a parameter reference.

parameters
Type: System.Data.Objects.ObjectParameter()

An optional set of query parameters that should be in scope when parsing.

Return Value

Type: System.Data.Objects.ObjectQuery(Of T)

A new ObjectQuery(Of T) instance that is equivalent to the original instance with both ORDER BY and SKIP applied.

Exception Condition
ArgumentNullException

Any argument is null.

ArgumentException

keys is an empty string.

-or-

count is an empty string.

The Skip method cannot be used after the Top method. When you use Top after Skip, it functions like the LIMIT statement of an clause.

This example gets five Product objects after skipping the first three in the query result, sorted by Product.ListPrice.

Using context As New AdventureWorksEntities()
    ' Define the parameters used to define the "page" of returned data. 
    Dim skipValue As Integer = 3
    Dim limitValue As Integer = 5

    ' Define a query that returns a "page" or the full 
    ' Product data using the Skip and Top methods. 
    ' When Top() follows Skip(), it acts like the LIMIT statement. 
    Dim query As ObjectQuery(Of Product) = _
        context.Products.Skip("it.ListPrice", "@skip", _
            New ObjectParameter("skip", skipValue)).Top("@limit", New ObjectParameter("limit", limitValue))

    ' Iterate through the page of Product items. 
    For Each result As Product In query
        Console.WriteLine("ID: {0}; Name: {1}", result.ProductID, result.Name)
    Next
End Using

.NET Framework
Available since 3.5
Return to top
Show: