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.
Namespace:
FileNet.Api.Collection
Assembly:
FileNet.Api (in FileNet.Api.dll)
Syntax
| Visual Basic (Declaration) |
|---|
Property PageSize As Integer |
| C# |
|---|
int PageSize { get; set; } |
| Visual C++ |
|---|
property int PageSize { int get (); void set (int value); } |
| JavaScript |
|---|
function get_pageSize(); function set_pageSize(value); |
Return Value
An integer value for the page size.
Exceptions
| Exception | Condition |
|---|---|
| FileNet.Api.Exception..::.EngineRuntimeException | Thrown if the enumerator is positioned before the first page or after the last page, or between pages after a Reset(mark) operation. |