TTMSMCPCursor.Encode Method

Encodes a position in a listing into the cursor string published with a page.

API unit family: TMS.MCP.Pagination Declaring type: TTMSMCPCursor

Syntax

class function Encode(AIndex: Integer): string; static;

Remarks

The value is encoded, not signed or encrypted, so it offers no protection against a client that alters it. A caller that acts on a decoded cursor should therefore re-check the index against the current number of entries before using it.

Parameters

Name	Description
AIndex	Zero-based index of the first entry that the next page should start at.

Returns

The index written as decimal text and Base64-encoded.