<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Control Procedures :: Aperio Documentation</title><link>/rpg/control/index.html</link><description>Chapter 6.3 RPG Control Procedures This chapter describes procedures used to read and write control values.</description><generator>Hugo</generator><language>en-us</language><lastBuildDate>Mon, 01 Jan 0001 00:00:00 +0000</lastBuildDate><atom:link href="/rpg/control/index.xml" rel="self" type="application/rss+xml"/><item><title>ctlGetLimit()</title><link>/rpg/control/ctlgetlimit/index.html</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/rpg/control/ctlgetlimit/index.html</guid><description>This procedure gets limit value for paging. If limit was not received from client then defult value is taken. There is possibility for developer to establish own deault value in case limit was not sent in request. Optional entry parameter to procedure can overwrite the default value of Aperio.
Parameter Type Description defaultLimit 10U 0 Optional This parameter is used to pass default limit in case requect don’t contain limit in control section. The procedure returns limit value which was sent in control section of request. If the default parameter for limit can not be established, then 0 is returned.</description></item><item><title>ctlGetOffset()</title><link>/rpg/control/ctlgetoffset/index.html</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/rpg/control/ctlgetoffset/index.html</guid><description>This procedure gets Offset value for paging. If offset was not received from client then procedure returns 0. There is no entry parameters for this procedure.
The procedure returns offset value which was sent in control section of request.
Examples:
xxOffset = ctlGetOffset(); // This line set xxOffset variable to value received from control // section of request. // If there is no Offset in request then the result is 0.</description></item><item><title>ctlGetOrderBy()</title><link>/rpg/control/ctlgetorderby/index.html</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/rpg/control/ctlgetorderby/index.html</guid><description>This procedure gets “orderBy” parameter from control section of request. This value can be used for order output by certain columns.
The procedure returns text value representing “orderBy” which was sent in “control” section. The length of text is limited to 1040characters.
See “How to implementsorting” article.
Examples:
xxOrderBy = ctlGetOrderBy();</description></item><item><title>ctlGetSearchText()</title><link>/rpg/control/ctlgetsearchtext/index.html</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/rpg/control/ctlgetsearchtext/index.html</guid><description>This procedure gets search text for live search function. If search text was not received from client then defult value is BLANK.
The procedure returns text provided in control section in “freeTextSearch” field.
Examples:
xxTextSearch = ctlGetearch Text(); // This line set xxTextSearch variable to value received from control // section of request. // If there is no freeTextSearch field in request then the result is *BLANKS.</description></item><item><title>ctlSetMore()</title><link>/rpg/control/ctlsetmore/index.html</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/rpg/control/ctlsetmore/index.html</guid><description>This procedure sets “more” boolean flag in the response. The “more” boolean value is used by paging functionality.
Parameter Type Description value N Optional Pass indicatir value to indicate if selected data has more rows. The value wil pe put into control section of response. If the value is not provided the “more” data in control section will be set to true. The doesn’t return any value. If programer uses this procedure in program then Aperio will automatically indcate in metadata that control parameter “more” is handled by RPG program.</description></item><item><title>ctlSetTotal()</title><link>/rpg/control/ctlsettotal/index.html</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>/rpg/control/ctlsettotal/index.html</guid><description>This procedure sets total value in the response. The total value is used by paging functionality.
Parameter Type Description total 10U 0 Mandatory Pass total number of rows in selected data. The value wil pe put into control section of response. The doesn’t return any value. If programer uses this procedure in program then Aperio will automatically indcate in metadata that control parameter “total” is handled by RPG program.</description></item></channel></rss>