QuerySkip Property

The number of entries to skip when querying a service.

Object Oriented Interface

public function getQuerySkip();
public function setQuerySkip($value);

Procedural Interface

ipworks_odata_get($res, 78 );
ipworks_odata_set($res, 78, $value );

Default Value

''

Remarks

This property allows you to specify the number of entries to skip (from the top of the list) when calling QueryService. Therefore when this property set, only the remaining entries (starting with entry N+1) will be returned. The specified value should not be a value less than 0.

By default, the service you are querying will sort the entries using a scheme selected by the OData service you are querying. However you can use QueryOrderBy to specify how the entries should be sorted prior to skipping the top N items.

This property can be used in conjunction with QueryOrderBy and QueryTop to select specific entries. For example, if you wanted to select the third and fourth highest rated item you would set QueryOrderBy to "Rating desc" (to order the items by Rating from highest to lowest), set QuerySkip to "2" (to skip the first and second items), and finally set QueryTop to "2" (to only return the third and fourth items).

This property is not available at design time.

Data Type

String