ArxPagingParameters

Definition

Namespace

ARX.SDK.Query

Package

ARX.SDK

public sealed class ArxPagingParameters

Constructor

No public constructor: create one with:

• ArxPagingParameters.PageNumber(string pageNumber, string pageSize, string? totalRecordCount = null)

  The routine takes a page number (from 1) and a page size: PageNumber("p_page", "p_page_size", totalRecordCount: "p_total").

  Parameter	Type	Description
  pageNumber	string	The routine's page number parameter.
  pageSize	string	The routine's page size parameter.
  totalRecordCount	string?= null	Where the routine returns the total: an OUT parameter of a procedure, or a result column of a function. Null when it doesn't.

• ArxPagingParameters.OffsetLimit(string offset, string limit, string? totalRecordCount = null)

  The routine takes an offset and a limit: OffsetLimit("p_offset", "p_limit", totalRecordCount: "p_total").

  Parameter	Type	Description
  offset	string	The routine's offset parameter (rows to skip).
  limit	string	The routine's limit parameter (rows to return).
  totalRecordCount	string?= null	Where the routine returns the total: an OUT parameter of a procedure, or a result column of a function. Null when it doesn't.

Properties

• ArxPagingParametersStyle Style { get; }

  Whether the routine takes a page number and size, or an offset and a limit.

• string First { get; }

  The page number's parameter (PageNumber style) or the offset's (OffsetLimit style).

• string Second { get; }

  The page size's parameter (PageNumber style) or the limit's (OffsetLimit style).

• string? TotalRecordCount { get; }

  Where the routine returns the total: a procedure's OUT parameter (ARX declares it as bigint if it isn't), or a function's result column. Null when the routine returns none.

Usage

procedure.PagingParameters = ArxPagingParameters.PageNumber("p_page", "p_page_size", totalRecordCount: "p_total");

Page through a procedure's result: the procedure pages itself, ARX pages a function, ARX pages a result set, scenario 1

Used in:

• Page through a procedure's result: the procedure pages itself, ARX pages a function, ARX pages a result setExecute
• Export what a procedure returns, page by pageExecute