The IPageEnumerator type exposes the following members.

ToggleProperties

Type NameDescription
Public propertyCurrentPage
Returns the current page in the set.
Public propertyElementCount
Returns the number of elements in the current page. The returned value is always equal to the value returned by GetCurrentPage().length. Use GetElementCount to avoid copying the potentially large internal array just to get its length.
Public propertyPageMark
Returns the current page mark on which a subsequent call to Reset will operate. Call this method before calling the Reset(mark) method.
Public propertyPageSize
The internal paging size used by the enumerator.

Gets or sets the internal paging size used by the enumerator.

Setting a new size takes effect on the next fetch from the server. Typical use cases for changing the page size are to match the number of displayed elements in a user interface or to improve performance of page retrieval.

Public propertyTotalCount
The count requested in a search that includes OPTIONS (COUNT_LIMIT N).

Possible values are:

  • A null value to indicate that this is the last page, the count limit is less than or equal to the page size, or counting is disabled on the server.
  • A value greater than zero to indicate an exact count; that is, all the rows were found, and the number found is less than the count limit.
  • A negative of the COUNT_LIMIT value to indicate that the minimum count was found, meaning that the count is at least N. If Top M is specified on the search, counting is not done past M , and an exact count is returned if the number of rows found is less than or equal to M when M <= N.

ToggleSee Also