AddField (HttpRequest subroutine) - Revision history

Dme: /* Syntax terms */

2013-03-05T15:31:21Z

Syntax terms

← Older revision		Revision as of 15:31, 5 March 2013
Line 20:		Line 20:
	</td></tr>		</td></tr>
	<tr><th>translate</th>		<tr><th>translate</th>
	<td>This optional parameter controls whether the <var class="term">fieldValue</var> content is processed with EBCDIC-to-ASCII translation. If <var class="term">translate</var> is not specified, the default is <var>True</var> (use EBCDIC-to-ASCII translation). If the value is <var>False</var>, no translation occurs.		<td>This optional <var>Boolean</var> parameter controls whether the <var class="term">fieldValue</var> content is processed with EBCDIC-to-ASCII translation. If <var class="term">translate</var> is not specified, the default is <var>True</var> (use EBCDIC-to-ASCII translation). If the value is <var>False</var>, no translation occurs.

	</td></tr></table>		</td></tr></table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>

JAL2 at 14:47, 21 June 2011

2011-06-21T14:47:40Z

← Older revision		Revision as of 14:47, 21 June 2011
Line 7:		Line 7:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>httpRequest</th>		<tr><th>httpRequest</th>
	<td>A previously defined and instantiated <var>~~httpRequest~~</var> object.		<td>A previously defined and instantiated <var>HttpRequest</var> object.
	</td></tr>		</td></tr>
	<tr><th>fieldName</th>		<tr><th>fieldName</th>
Line 19:		Line 19:
	<td>A string that identifies the file to be uploaded. The default is no file specification, that is, a non-file data Post. This is an optional parameter.		<td>A string that identifies the file to be uploaded. The default is no file specification, that is, a non-file data Post. This is an optional parameter.
	</td></tr>		</td></tr>
	<tr><th>~~xlatflag~~</th>		<tr><th>translate</th>
	<td>This optional parameter controls whether the <var class="term">fieldValue</var> content is processed with EBCDIC-to-ASCII translation. If <var class="term">~~xlatflag~~</var> is not specified, the default is <var>True</var> (use EBCDIC-to-ASCII translation). If the value is <var>False</var>, no translation occurs.		<td>This optional parameter controls whether the <var class="term">fieldValue</var> content is processed with EBCDIC-to-ASCII translation. If <var class="term">translate</var> is not specified, the default is <var>True</var> (use EBCDIC-to-ASCII translation). If the value is <var>False</var>, no translation occurs.

	</td></tr></table>		</td></tr></table>
Line 26:		Line 26:
	<ul>		<ul>
	<li>See <var>[[MultiPartFormEncoding (HttpRequest property)\|MultiPartFormEncoding]]</var> for information about using <var>AddField</var> for a form used to Post file data.		<li>See <var>[[MultiPartFormEncoding (HttpRequest property)\|MultiPartFormEncoding]]</var> for information about using <var>AddField</var> for a form used to Post file data.
	<li><var>AddField</var> is designed for requests that have the <code>application/x-www-form-urlencoded</code> or <code>multipart/form-data</code> content types. It is an error to use <var>AddField</var> in a request that has, say, a "text/xml" content type.		<li><var>AddField</var> is designed for requests that have the <code>application/x-www-form-urlencoded</code> or <code>multipart/form-data</code> content types. It is an error to use <var>AddField</var> in a request that has, say, a <code>text/xml</code> content type.
	<li>If form fields are defined with <var>AddField</var>, no explicit content type is set with <var>[[AddHeader (HttpRequest subroutine)\|AddHeader]]</var>, and multipart form encoding is ''not'' enabled with		<li>If form fields are defined with <var>AddField</var>, no explicit content type is set with <var>[[AddHeader (HttpRequest subroutine)\|AddHeader]]</var>, and multipart form encoding is ''not'' enabled with
	<var>[[MultiPartFormEncoding (HttpRequest property)\|MultiPartFormEncoding]]</var>. ~~the~~ <var class="product">HTTP Helper</var> automatically sends the following request		<var>MultiPartFormEncoding (HttpRequest property)\|MultiPartFormEncoding</var>. The <var class="product">HTTP Helper</var> automatically sends the following request
	header on Post calls:		header on <var>Post</var> calls:
	<p class="code"> content-type: application/x-www-form-urlencoded		<p class="code"> content-type: application/x-www-form-urlencoded
	</p>		</p>
Line 35:		Line 35:

	==Example==		==Example==
	~~<ol>~~		The following <var class="product">User Language</var> prompts for a procedure name, stores the procedure in a <var>Stringlist</var>, and uploads the procedure using multipart form encoding.
	~~<li>~~The following <var class="product">User Language</var> prompts for a procedure name, stores the procedure in a <var>Stringlist</var>, and uploads the procedure using multipart form encoding.
	<p class="code">begin		<p class="code">begin
	%request is object httpRequest		%request is object httpRequest
Line 64:		Line 63:
	print %response:[[Content_(HttpResponse_function)\|content]]		print %response:[[Content_(HttpResponse_function)\|content]]
	end		end
	</p~~></ol~~>		</p>

	==See also==		==See also==

Goff: (start) matching syntax terms to syntax box (will need further review when syntax box fixed), edits, tags and links.

2011-06-18T06:31:35Z

(start) matching syntax terms to syntax box (will need further review when syntax box fixed), edits, tags and links.

← Older revision		Revision as of 06:31, 18 June 2011
Line 1:		Line 1:
	{{Template:HttpRequest:AddField subtitle}}		{{Template:HttpRequest:AddField subtitle}}
			The <var>AddField</var> method lets you add a form field name and value pair to the HTTP request that is to be sent to the HTTP server.

	~~This method lets you add a form field name and~~
	~~value pair to the HTTP request that is to be sent to the HTTP server.~~
	==Syntax==		==Syntax==
	{{Template:HttpRequest:AddField syntax}}		{{Template:HttpRequest:AddField syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>~~%httpreq~~</th>		<tr><th>httpRequest</th>
	<td>A previously defined and instantiated <var>~~HttpRequest~~</var> object.		<td>A previously defined and instantiated <var>httpRequest</var> object.
	</td></tr>		</td></tr>
	<tr><th>~~fieldname~~</th>		<tr><th>fieldName</th>
	<td>A string expression that names an HTTP form field. Field names are case insensitive.		<td>A string expression that names an HTTP form field. Field names are case insensitive.
	Passing multiple occurrences is allowed: if a same-named field is already present, an additional instance is added.		Passing multiple occurrences is allowed; if a same-named field is already present, an additional instance is added.
	</td></tr>		</td></tr>
	<tr><th>~~fieldvalue~~</th>		<tr><th>fieldValue</th>
	<td>A <var>Longstring</var> or a <var>Stringlist</var> object expression that results in a value for the field. If it is a <var>Stringlist</var>, a line-end sequence is appended to each <var>Stringlist</var> item as it is added to the Post data. The <var>[[LineEnd (HttpRequest property)\|LineEnd]]</var> property sets which of three line-end sequence options is appended.		<td>A <var>[[Longstrings\|Longstring]]</var> or a <var>[[Stringlist class\|Stringlist]]</var> object expression that results in a value for the field. If it is a <var>Stringlist</var>, a line-end sequence is appended to each <var>Stringlist</var> item as it is added to the Post data. The <var>[[LineEnd (HttpRequest property)\|LineEnd]]</var> property sets which of three line-end sequence options is appended.
	</td></tr>		</td></tr>
	<tr><th>file</th>		<tr><th>file</th>
Line 21:		Line 20:
	</td></tr>		</td></tr>
	<tr><th>xlatflag</th>		<tr><th>xlatflag</th>
	<td>This optional parameter controls whether the ~~''fieldvalue''~~ content ~~gets~~ EBCDIC-to-ASCII translation. If ''xlatflag'' is not specified, the default is <var>True</var> (use EBCDIC-to-ASCII translation). If the value is <var>False</var>, no translation occurs.		<td>This optional parameter controls whether the <var class="term">fieldValue</var> content is processed with EBCDIC-to-ASCII translation. If <var class="term">xlatflag</var> is not specified, the default is <var>True</var> (use EBCDIC-to-ASCII translation). If the value is <var>False</var>, no translation occurs.

	</td></tr></table>		</td></tr></table>
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>See <var>[[MultiPartFormEncoding (HttpRequest property)\|MultiPartFormEncoding]]</var> for information about using <var>AddField</var>		<li>See <var>[[MultiPartFormEncoding (HttpRequest property)\|MultiPartFormEncoding]]</var> for information about using <var>AddField</var> for a form used to Post file data.
	for a form used to Post file data.		<li><var>AddField</var> is designed for requests that have the <code>application/x-www-form-urlencoded</code> or <code>multipart/form-data</code> content types. It is an error to use <var>AddField</var> in a request that has, say, a "text/xml" content type.
	<li><var>AddField</var> is designed for requests that have the		<li>If form fields are defined with <var>AddField</var>, no explicit content type is set with <var>[[AddHeader (HttpRequest subroutine)\|AddHeader]]</var>, and multipart form encoding is ''not'' enabled with
	<code>application/x-www-form-urlencoded</code> or <code>multipart/form-data</code>		<var>[[MultiPartFormEncoding (HttpRequest property)\|MultiPartFormEncoding]]</var>. the <var class="product">HTTP Helper</var> automatically sends the following request
	content types.
	It is an error to use <var>AddField</var> in a request that has, say, a "text/xml"
	content type.
	<li>If form fields are defined with <var>AddField</var>, no explicit content type is set
	with <var>[[AddHeader (HttpRequest subroutine)\|AddHeader]]</var>,
	and multipart form encoding is ''not'' enabled with
	<var>[[MultiPartFormEncoding (HttpRequest property)\|MultiPartFormEncoding]]</var>.
	the <var class="product">HTTP Helper</var> automatically sends the following request
	header on Post calls:		header on Post calls:
	<p class="code"> content-type: application/x-www-form-urlencoded		<p class="code"> content-type: application/x-www-form-urlencoded
	</p>		</p>
	~~<li>For information about <var>Stringlist</var> processing, see [[Stringlist class\|"Stringlist class"]].~~
	</ul>		</ul>

	==Example==		==Example==
	The following <var class="product">User Language</var> prompts for a procedure name, stores the procedure in a <var>Stringlist</var>, and uploads the procedure using multipart form encoding.<p class="code">begin		<ol>
	%request is object ~~HttpRequest~~		<li>The following <var class="product">User Language</var> prompts for a procedure name, stores the procedure in a <var>Stringlist</var>, and uploads the procedure using multipart form encoding.
	%response is object ~~HTTPResponse~~		<p class="code">begin
	%upfile is object ~~<var>Stringlist</var>~~		%request is object httpRequest
			%response is object httpResponse
			%upfile is object stringlist

	%procname is string len 255		%procname is string len 255
Line 54:		Line 46:

	%procname = $read('Enter proc name please')		%procname = $read('Enter proc name please')
	%rc = $procopn( %procname )		%rc = [[$ProcOpn\|$procopn]]( %procname )
	if ( %rc ) then		if ( %rc ) then
	print 'could not open the proc, dude.'		print 'could not open the proc, dude.'
	stop		stop
	end if		end if
	%upfile = new		%upfile = [[New_(Stringlist_constructor)\|new]]
	%upfile:~~AppendOpenProcedure~~		%upfile:[[AppendOpenProcedure_(Stringlist_function)\|appendOpenProcedure]]
	%rc = $proccls		%rc = [[$ProcCls\|$proccls]]
	%upfile:print		%upfile:[[Print_(Stringlist_function)\|print]]
	%request = new		%request = [[New_(HttpRequest_constructor)\|new]]
	%request:URL = 'whatever'		%request:URL = 'whatever'
	%request:~~MultiPartFormEncoding~~ = true		%request:multiPartFormEncoding = true
	%request:~~LineEnd~~ = CR		%request:lineEnd = CR
	%request:addField('filename',%upfile,%procname)		%request:addField('filename',%upfile,%procname)
	%response = %request:post( 'CSOCK' )		%response = %request:[[Post_(HttpRequest_function)\|post]]( 'CSOCK' )
	print %response:statusline		print %response:[[StatusLine_(HttpResponse_function)\|statusline]]
	print %response:content		print %response:[[Content_(HttpResponse_function)\|content]]
	end		end
	</p>		</p></ol>

	==See also==		==See also==
			<ul>
			<li>For information about <var>Stringlist</var> processing, see [[Stringlist class\|"Stringlist class"]].
			</ul>
	{{Template:HttpRequest:AddField footer}}		{{Template:HttpRequest:AddField footer}}

Dme: /* Usage notes */

2011-06-16T20:20:12Z

Usage notes

← Older revision		Revision as of 20:20, 16 June 2011
Line 26:		Line 26:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>See <var>[[~~MultipartFormEncoding~~ (HttpRequest property)]]</var> for information about using <var>AddField</var>		<li>See <var>[[MultiPartFormEncoding (HttpRequest property)\|MultiPartFormEncoding]]</var> for information about using <var>AddField</var>
	for a form used to Post file data.		for a form used to Post file data.
	<li><var>AddField</var> is designed for requests that have the		<li><var>AddField</var> is designed for requests that have the

DmeWiccan: 1 revision

2011-06-16T20:17:35Z

1 revision

← Older revision	Revision as of 20:17, 16 June 2011
(No difference)

DmeWiccan: 1 revision

2011-06-16T20:17:33Z

1 revision

← Older revision		Revision as of 20:17, 16 June 2011
Line 8:		Line 8:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%httpreq</th>		<tr><th>%httpreq</th>
	<td>A previously defined and instantiated <var>~~HTTPRequest~~</var> object.		<td>A previously defined and instantiated <var>HttpRequest</var> object.
	</td></tr>		</td></tr>
	<tr><th>fieldname</th>		<tr><th>fieldname</th>
Line 15:		Line 15:
	</td></tr>		</td></tr>
	<tr><th>fieldvalue</th>		<tr><th>fieldvalue</th>
	<td>A <var>Longstring</var> or a <var>Stringlist</var> object expression that results in a value for the field. If it is a <var>Stringlist</var>, a line-end sequence is appended to each <var>Stringlist</var> item as it is added to the Post data. The <var>[[LineEnd (~~HTTPRequest~~ property)\|LineEnd]]</var> property sets which of three line-end sequence options is appended.		<td>A <var>Longstring</var> or a <var>Stringlist</var> object expression that results in a value for the field. If it is a <var>Stringlist</var>, a line-end sequence is appended to each <var>Stringlist</var> item as it is added to the Post data. The <var>[[LineEnd (HttpRequest property)\|LineEnd]]</var> property sets which of three line-end sequence options is appended.
	</td></tr>		</td></tr>
	<tr><th>file</th>		<tr><th>file</th>
Line 26:		Line 26:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>See <var>[[MultipartFormEncoding (~~HTTPRequest~~ property)]]</var> for information about using <var>AddField</var>		<li>See <var>[[MultipartFormEncoding (HttpRequest property)]]</var> for information about using <var>AddField</var>
	for a form used to Post file data.		for a form used to Post file data.
	<li><var>AddField</var> is designed for requests that have the		<li><var>AddField</var> is designed for requests that have the
Line 34:		Line 34:
	content type.		content type.
	<li>If form fields are defined with <var>AddField</var>, no explicit content type is set		<li>If form fields are defined with <var>AddField</var>, no explicit content type is set
	with <var>[[AddHeader (~~HTTPRequest~~ subroutine)\|AddHeader]]</var>,		with <var>[[AddHeader (HttpRequest subroutine)\|AddHeader]]</var>,
	and multipart form encoding is ''not'' enabled with		and multipart form encoding is ''not'' enabled with
	<var>[[MultiPartFormEncoding (~~HTTPRequest~~ property)\|MultiPartFormEncoding]]</var>.		<var>[[MultiPartFormEncoding (HttpRequest property)\|MultiPartFormEncoding]]</var>.
	the <var class="product">HTTP Helper</var> automatically sends the following request		the <var class="product">HTTP Helper</var> automatically sends the following request
	header on Post calls:		header on Post calls:
Line 46:		Line 46:
	==Example==		==Example==
	The following <var class="product">User Language</var> prompts for a procedure name, stores the procedure in a <var>Stringlist</var>, and uploads the procedure using multipart form encoding.<p class="code">begin		The following <var class="product">User Language</var> prompts for a procedure name, stores the procedure in a <var>Stringlist</var>, and uploads the procedure using multipart form encoding.<p class="code">begin
	%request is object ~~HTTPRequest~~		%request is object HttpRequest
	%response is object HTTPResponse		%response is object HTTPResponse
	%upfile is object <var>Stringlist</var>		%upfile is object <var>Stringlist</var>

DmeWiccan: 1 revision

2011-06-16T20:16:25Z

1 revision

← Older revision	Revision as of 20:16, 16 June 2011
(No difference)

Dme: moved AddField (HTTPRequest subroutine) to AddField (HttpRequest subroutine)

2011-06-16T20:16:23Z

moved AddField (HTTPRequest subroutine) to AddField (HttpRequest subroutine)

← Older revision		Revision as of 20:16, 16 June 2011
Line 1:		Line 1:
	{{Template:~~HTTPRequest~~:AddField subtitle}}		{{Template:HttpRequest:AddField subtitle}}

	This method lets you add a form field name and		This method lets you add a form field name and
	value pair to the HTTP request that is to be sent to the HTTP server.		value pair to the HTTP request that is to be sent to the HTTP server.
	==Syntax==		==Syntax==
	{{Template:~~HTTPRequest~~:AddField syntax}}		{{Template:HttpRequest:AddField syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 74:		Line 74:
	</p>		</p>
	==See also==		==See also==
	{{Template:~~HTTPRequest~~:AddField footer}}		{{Template:HttpRequest:AddField footer}}

Dme: moved AddField (HTTPRequest subroutine) to AddField (HttpRequest subroutine)

2011-06-16T19:06:04Z

moved AddField (HTTPRequest subroutine) to AddField (HttpRequest subroutine)

← Older revision	Revision as of 19:06, 16 June 2011
(No difference)

JAL2 at 22:59, 15 June 2011

2011-06-15T22:59:46Z

← Older revision		Revision as of 22:59, 15 June 2011
Line 15:		Line 15:
	</td></tr>		</td></tr>
	<tr><th>fieldvalue</th>		<tr><th>fieldvalue</th>
	<td>A <var>Longstring</var> or a <var>Stringlist</var> object expression that results in a value for the field. If it is a <var>Stringlist</var>, a line-end sequence is appended to each <var>Stringlist</var> item as it is added to the Post data. The LineEnd (HTTPRequest property) sets which of three line-end sequence options is appended.		<td>A <var>Longstring</var> or a <var>Stringlist</var> object expression that results in a value for the field. If it is a <var>Stringlist</var>, a line-end sequence is appended to each <var>Stringlist</var> item as it is added to the Post data. The <var>[[LineEnd (HTTPRequest property)\|LineEnd]]</var> property sets which of three line-end sequence options is appended.
	</td></tr>		</td></tr>
	<tr><th>file</th>		<tr><th>file</th>
Line 21:		Line 21:
	</td></tr>		</td></tr>
	<tr><th>xlatflag</th>		<tr><th>xlatflag</th>
	<td>This optional parameter controls whether the ''fieldvalue'' content gets EBCDIC-to-ASCII translation. If ''xlatflag'' is not specified, the default is True (use EBCDIC-to-ASCII translation). If ~~set to~~ False, no translation occurs.		<td>This optional parameter controls whether the ''fieldvalue'' content gets EBCDIC-to-ASCII translation. If ''xlatflag'' is not specified, the default is <var>True</var> (use EBCDIC-to-ASCII translation). If the value is <var>False</var>, no translation occurs.

	</td></tr></table>		</td></tr></table>
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>See <var>[[MultipartFormEncoding (HTTPRequest property)]]</var> for information about using AddField		<li>See <var>[[MultipartFormEncoding (HTTPRequest property)]]</var> for information about using <var>AddField</var>
	for a form used to Post file data.		for a form used to Post file data.
	<li>AddField is designed for requests that have the		<li><var>AddField</var> is designed for requests that have the
	<code>application/x-www-form-urlencoded</code> or <code>multipart/form-data</code>		<code>application/x-www-form-urlencoded</code> or <code>multipart/form-data</code>
	content types.		content types.
	It is an error to use AddField in a request that has, say, a ~~&amp;amp;amp;ldquo;~~text/xml~~&amp;amp;amp;rdquo;~~		It is an error to use <var>AddField</var> in a request that has, say, a "text/xml"
	content type.		content type.
	<li>If form fields are defined with AddField, no explicit content type is set		<li>If form fields are defined with <var>AddField</var>, no explicit content type is set
	with <var>[[AddHeader (HTTPRequest subroutine)\|AddHeader]]</var>,		with <var>[[AddHeader (HTTPRequest subroutine)\|AddHeader]]</var>,
	and multipart form encoding is ''not'' enabled with		and multipart form encoding is ''not'' enabled with
	<var>[[MultiPartFormEncoding (HTTPRequest property)\|MultiPartFormEncoding]]</var>.		<var>[[MultiPartFormEncoding (HTTPRequest property)\|MultiPartFormEncoding]]</var>.
	the HTTP Helper automatically sends the following request		the <var class="product">HTTP Helper</var> automatically sends the following request
	header on Post calls:		header on Post calls:
	<p class="code"> content-type: application/x-www-form-urlencoded		<p class="code"> content-type: application/x-www-form-urlencoded
	</p>		</p>
	<li>For information about <var>Stringlist</var> processing, see ~~the~~ [[~~Janus SOAP Reference Manual~~]].		<li>For information about <var>Stringlist</var> processing, see [[Stringlist class\|"Stringlist class"]].
	</ul>		</ul>