Returns an opaque representation of the IPageEnumerator that can act as a checkpoint for a later resumption via Factory.PageEnumerator.ResumeInstance. The checkpoint does not preserve the IConnection information, the security context information, or the list of items in the page. Although the byte[] containing the checkpoint is reasonably compact, it can generally be made smaller by using generic compression. The information in the checkpoint is not encrypted or masked because it is not considered sensitive from the point of view of the API. Some collections with a IPageEnumerator are not actually pageable. The collection already holds all items in the set. Because a checkpoint does not include the individual items, it cannot be used to restore the IPageEnumerator state of such non-pageable collections. This method throws EngineRuntimeException if you try to create a checkpoint for that kind of collection.

Namespace:  FileNet.Api.Collection
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Function GetCurrentPageCheckpoint As Byte()
C#
byte[] GetCurrentPageCheckpoint()
Visual C++
array<unsigned char>^ GetCurrentPageCheckpoint()
JavaScript
function getCurrentPageCheckpoint();

ToggleSee Also