$Web - Revision history

Alex: /* Usage notes */

2020-01-20T19:34:15Z

Usage notes

← Older revision		Revision as of 19:34, 20 January 2020
Line 28:		Line 28:
	</ul>		</ul>
	In the example below, the variable %DISTRICT is set from a form field when running a web request and from a screen field otherwise:		In the example below, the variable %DISTRICT is set from a form field when running a web request and from a screen field otherwise:
	<p class="code">if $web ~~the~~		<p class="code">if $web then
	%district = $web_form_parm('DISTRICT')		%district = $web_form_parm('DISTRICT')
	else		else

Alex at 17:00, 20 January 2020

2020-01-20T17:00:45Z

← Older revision		Revision as of 17:00, 20 January 2020
Line 1:		Line 1:
	~~{{DISPLAYTITLE:$Web}}~~
	<span class="pageSubtitle">Determine whether running a web request</span>		<span class="pageSubtitle">Determine whether running a web request</span>

Line 24:		Line 23:
	<li>The <var>$Web</var> function is most useful for:		<li>The <var>$Web</var> function is most useful for:
	<ul>		<ul>
	<li>Preventing code that should only be run for a web request from running for 3270 (or other non-web) requests.		<li>Preventing code that should only be run for a web request from running for 3270 (or other non-web) requests.</li>
	<li>Ensuring that non-web, possibly 3270 specific code, is not run for web requests.		<li>Ensuring that non-web, possibly 3270 specific code, is not run for web requests.</li>
			<li>Under Model 204 7.8 and later, transactional daemon descendants of a web thread can also access the web API. However, $Web returns 0 on these threads. To check if the web API is available regardless of the thread type use [[$Web_Api]].</li>
	</ul>		</ul>
	In the example below, the variable %DISTRICT is set from a form field when running a web request and from a screen field otherwise:		In the example below, the variable %DISTRICT is set from a form field when running a web request and from a screen field otherwise:
	<p class="code">IF $~~Web THEN~~		<p class="code">if $web the
	%~~DISTRICT~~ = $~~Web_Form_Parm~~('DISTRICT')		%district = $web_form_parm('DISTRICT')
	~~ELSE~~		else
	%~~DISTRICT~~ = %~~QUERY~~:~~DISTRICT~~		%district = %query:district
	~~END IF~~		end if
	</p>		</p>

DmeWiccan: Automatically generated page update

2013-04-09T13:38:49Z

Automatically generated page update

← Older revision		Revision as of 13:38, 9 April 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:$Web}}		{{DISPLAYTITLE:$Web}}
	<span class="pageSubtitle"~~><section begin="desc" /~~>Determine whether running a web request~~<section end="desc" />~~</span>		<span class="pageSubtitle">Determine whether running a web request</span>

	<var>$Web</var> indicates whether the current processing is the result of a request to <var class="product">[[Janus Web Server]]</var>.		<var>$Web</var> indicates whether the current processing is the result of a request to <var class="product">[[Janus Web Server]]</var>.
Line 7:		Line 7:

	==Syntax==		==Syntax==
	<p class="syntax"~~><section begin="syntax" /~~><span class="term">%rc</span> = $Web		<p class="syntax"><span class="term">%rc</span> = $Web
	~~<section end="syntax" />~~</p>		</p>

	===Return codes===		===Return codes===

JALWiccan: 1 revision

2012-10-17T21:45:48Z

1 revision

← Older revision	Revision as of 21:45, 17 October 2012
(No difference)

JAL2 at 21:45, 17 October 2012

2012-10-17T21:45:47Z

← Older revision		Revision as of 21:45, 17 October 2012
Line 7:		Line 7:

	==Syntax==		==Syntax==
	<p class="syntax"><section begin="syntax" />%rc = $Web		<p class="syntax"><section begin="syntax" /><span class="term">%rc</span> = $Web
	<section end="syntax" /></p>		<section end="syntax" /></p>

JAL2 at 21:00, 16 June 2012

2012-06-16T21:00:08Z

← Older revision		Revision as of 21:00, 16 June 2012
Line 2:		Line 2:
	<span class="pageSubtitle"><section begin="desc" />Determine whether running a web request<section end="desc" /></span>		<span class="pageSubtitle"><section begin="desc" />Determine whether running a web request<section end="desc" /></span>

	$Web indicates whether the current processing is the result of a request to <var class="product">[[Janus Web Server]]</var>.		<var>$Web</var> indicates whether the current processing is the result of a request to <var class="product">[[Janus Web Server]]</var>.

			<var>$Web</var> takes no arguments and returns either a 0 or a 1.

	==Syntax==		==Syntax==
	<p class="syntax"><section begin="syntax" /> %RC = $Web		<p class="syntax"><section begin="syntax" />%rc = $Web
	<section end="syntax" /></p>		<section end="syntax" /></p>

	~~$Web takes no arguments and returns either a 0 or a 1.~~		===Return codes===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>Code</th>		<tr><th>Code</th>
	<td>Meaning</td></tr>		<th>Meaning</th></tr>
	<tr><th>0</th>		<tr><th>0</th>
	<td>Not running a web request.</td></tr>		<td>Not running a web request.</td></tr>
	<tr><th>1</th>		<tr><th>1</th>
	<td>Running a web request.</td></tr>		<td>Running a web request.</td></tr>

	</table>		</table>
	~~<p class="caption">$WEB return codes</p>~~

	The $Web function is most useful for ~~preventing~~ code that should only be run for a web request from running for 3270 (or other non-web) requests ~~and for ensuring~~ that non-web, possibly 3270 specific code is not run for web requests.		==Usage notes==
	<p class="code"> IF $Web THEN		<ul>
	%DISTRICT = $Web_Form_Parm('DISTRICT')		<li>The <var>$Web</var> function is most useful for:
	ELSE		<ul>
	%DISTRICT = %QUERY:DISTRICT		<li>Preventing code that should only be run for a web request from running for 3270 (or other non-web) requests.
	END IF		<li>Ensuring that non-web, possibly 3270 specific code, is not run for web requests.
			</ul>
			In the example below, the variable %DISTRICT is set from a form field when running a web request and from a screen field otherwise:
			<p class="code">IF $Web THEN
			%DISTRICT = $Web_Form_Parm('DISTRICT')
			ELSE
			%DISTRICT = %QUERY:DISTRICT
			END IF
	</p>		</p>

	~~In this example, the variable %DISTRICT is set from a form field when running a web request and from a screen field otherwise.~~ $Web has several advantages over other techniques for determining whether a request is running a web request such as checking $Web_Port or doing a $VIEW('IODEV'):		<li><var>$Web</var> has several advantages over other techniques for determining whether a request is running a web request, such as checking <var>[[$Web_Port]]</var> or doing a <code>$VIEW('IODEV')</code>:
			<ul>
	<ol>
	<li>It is syntactically simple and easy to understand.		<li>It is syntactically simple and easy to understand.
	<li>It works correctly even when a request is being debugged using JANUSDEBUG.		<li>It works correctly even when a request is being debugged using JANUSDEBUG.
	<li>It works correctly and does not cause a "CONNECTION WAS LOST" user restart after the connection was closed either with a <var>$Web_Done</var> or by the browser. This can be especially useful if there is web-specific processing, like APSY navigation code, that happens after a <var>$Web_Done</var>.		<li>It works correctly and does not cause a "CONNECTION WAS LOST" user restart after the connection was closed either with a <var>[[$Web_Done]]</var> or by the browser. This can be especially useful if there is web-specific processing, like APSY navigation code, that happens after a <var>$Web_Done</var>.
	</ol>		</ul>

	[[Category:Janus Web Server $functions\|$Web]]		[[Category:Janus Web Server $functions\|$Web]]

JALWiccan: 1 revision

2012-06-15T22:24:57Z

1 revision

← Older revision	Revision as of 22:24, 15 June 2012
(No difference)

JAL2: /* Syntax */

2012-06-15T22:24:56Z

Syntax

← Older revision		Revision as of 22:24, 15 June 2012
Line 2:		Line 2:
	<span class="pageSubtitle"><section begin="desc" />Determine whether running a web request<section end="desc" /></span>		<span class="pageSubtitle"><section begin="desc" />Determine whether running a web request<section end="desc" /></span>

	$Web indicates whether the current processing is the result of a request to ''[[Janus Web Server]]''.		$Web indicates whether the current processing is the result of a request to <var class="product">[[Janus Web Server]]</var>.
	==Syntax==		==Syntax==
	<p class="syntax"><section begin="syntax" /> %RC = $Web		<p class="syntax"><section begin="syntax" /> %RC = $Web

JAL2: /* Syntax */

2012-06-06T19:07:21Z

Syntax

← Older revision		Revision as of 19:07, 6 June 2012
Line 32:		Line 32:
	<li>It is syntactically simple and easy to understand.		<li>It is syntactically simple and easy to understand.
	<li>It works correctly even when a request is being debugged using JANUSDEBUG.		<li>It works correctly even when a request is being debugged using JANUSDEBUG.
	<li>It works correctly and does not cause a "CONNECTION WAS LOST" user restart after the connection was closed either with a <var>$Web_Done</var> or by the browser. This can be especially useful if there is web-specific processing, like APSY navigation code, that happens after a $Web_Done.		<li>It works correctly and does not cause a "CONNECTION WAS LOST" user restart after the connection was closed either with a <var>$Web_Done</var> or by the browser. This can be especially useful if there is web-specific processing, like APSY navigation code, that happens after a <var>$Web_Done</var>.
	</ol>		</ol>

	[[Category:Janus Web Server $functions\|$Web]]		[[Category:Janus Web Server $functions\|$Web]]

JALWiccan: 1 revision

2012-06-06T19:06:29Z

1 revision

← Older revision	Revision as of 19:06, 6 June 2012
(No difference)