LineEnd (HttpRequest property) - Revision history

JAL: /* LineEnd enumeration */

2014-07-10T19:48:05Z

LineEnd enumeration

New page

{{Template:HttpRequest:LineEnd subtitle}}
The <var>LineEnd</var> settable property lets you select which of three line-end sequences to use when you add a file to form Post data by passing a <var>[[Stringlist class|Stringlist]]</var> object to the <var>[[AddField_(HttpRequest_subroutine)|AddField]]</var> method.

==Syntax==
{{Template:HttpRequest:LineEnd syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%currentLineEnd</th>
<td>The string variable that will be assignment the current value of <var>LineEnd</var>.</td></tr>
<tr><th>httpRequest</th>
<td>A previously defined and instantiated <var>HttpRequest</var> object.</td></tr>
<tr><th>newLineEnd</th>
<td>Identifies the new line-end sequence to use for the <var>Stringlist</var> items being copied into the Post data. Each copied <var>Stringlist</var> item has a line-end sequence appended to it. The options you may specify are these <var>LineEnd</var> enumeration (see below) values: <var>CRLF</var>, <var>CR</var>, and <var>LF</var>.
</td></tr></table>

===LineEnd enumeration===
The values of this [[Enumerations|enumeration]] are the following:
<table class="syntaxNested">
<tr><th><var>CRLF</var> </th>
<td>Use carriage-return/line-feed (hex value X'0D0A'). This is the default for a newly created <var>HttpRequest</var> object. </td></tr>

<tr><th><var>CR</var> </th>
<td>Use only carriage-return (X'0D'). </td></tr>

<tr><th><var>LF</var> </th>
<td>Use only line-feed (X'0A'). </td></tr>
</table>

<p class="note">'''Note:''' As with all enumerations, the <var>ToString</var> method implicitly converts an enumeration value to a character string whose value is the name of the enumeration value. For more information about methods available to all enumerations, see [[Enumerations#Common enumeration methods|Common enumeration methods]]. </p>

==Usage notes==
<ul>
<li>The <var>LineEnd</var> property must be set '''before''' the <var>AddField</var> call that adds the form data.
<li>The <var>LineEnd</var> setting remains in effect unless the property is reset with another assignment.
<li>For an example of code that uses the <var>LineEnd</var> property, see [[AddField (HttpRequest subroutine)#Example|this]] <var>AddField</var> example.
</ul>

==Example==
The <var>LineEnd</var> format is shown in the following fragment:
<p class="code"> %HttpRequest:LineEnd = CRLF
%HttpRequest:LineEnd = CR
%HttpRequest:LineEnd = LF
%HttpRequest:AddField( ....
</p>

==See also==
<ul><li>For more general information and background about using Enumerations, see [[Enumerations|"Enumerations"]].
</ul>
{{Template:HttpRequest:LineEnd footer}}

JAL2: /* Syntax terms */

2011-08-16T21:10:08Z

Syntax terms

← Older revision		Revision as of 21:10, 16 August 2011
Line 11:		Line 11:
	<td>A previously defined and instantiated <var>HttpRequest</var> object.</td></tr>		<td>A previously defined and instantiated <var>HttpRequest</var> object.</td></tr>
	<tr><th>newLineEnd</th>		<tr><th>newLineEnd</th>
	<td>Identifies the new line-end sequence to use for the <var>Stringlist</var> items being copied into the Post data. Each copied <var>Stringlist</var> item has a line-end sequence appended to it. The options you may specify are these <var>LineEnd</var> ~~<var>Enumeration</var>~~ (see below) values: <var>CRLF</var>, <var>CR</var>, and <var>LF</var>.		<td>Identifies the new line-end sequence to use for the <var>Stringlist</var> items being copied into the Post data. Each copied <var>Stringlist</var> item has a line-end sequence appended to it. The options you may specify are these <var>LineEnd</var> enumeration (see below) values: <var>CRLF</var>, <var>CR</var>, and <var>LF</var>.
	</td></tr></table>		</td></tr></table>

	<h3>LineEnd enumeration</h3>		<h3>LineEnd enumeration</h3>
	The values of this enumeration are the following:		The values of this [[Enumerations\|enumeration]] are the following:
	<table class="syntaxNested">		<table class="syntaxNested">
	<tr><th>CRLF </th>		<tr><th>CRLF </th>
Line 24:		Line 24:
	<td>Use only line-feed (X'0A'). </td></tr>		<td>Use only line-feed (X'0A'). </td></tr>
	</table>		</table>

			'''Note:''' As with all enumerations, the <var>ToString</var> method implicitly converts an enumeration value to a character string whose value is the name of the enumeration value. For more information about methods available to all enumerations, see [[Enumerations#Common enumeration methods\|"Common enumeration methods"]].

	==Usage notes==		==Usage notes==

JAL2: /* Syntax terms */

2011-06-24T20:21:28Z

Syntax terms

@@ Line 11: / Line 11: @@
 <td>A previously defined and instantiated <var>HttpRequest</var> object.</td></tr>
 <tr><th>newLineEnd</th>
-<td>Identifies the new line-end sequence to use for the <var>Stringlist</var> items being copied into the Post data. Each copied <var>Stringlist</var> item has a line-end sequence appended to it. The options you may specify are these <var>LineEnd</var> <var>Enumeration</var> values:
+<td>Identifies the new line-end sequence to use for the <var>Stringlist</var> items being copied into the Post data. Each copied <var>Stringlist</var> item has a line-end sequence appended to it. The options you may specify are these <var>LineEnd</var> <var>Enumeration</var> (see below) values: <var>CRLF</var>, <var>CR</var>, and <var>LF</var>.
 </td></tr></table>
 ==Usage notes==

JAL2 at 20:07, 21 June 2011

2011-06-21T20:07:09Z

← Older revision		Revision as of 20:07, 21 June 2011
Line 8:		Line 8:
	<tr><th>%currentLineEnd</th>		<tr><th>%currentLineEnd</th>
	<td>The string variable that will be assignment the current value of <var>LineEnd</var>.</td></tr>		<td>The string variable that will be assignment the current value of <var>LineEnd</var>.</td></tr>
	<tr><th>%httpRequest</th>		<tr><th>httpRequest</th>
	<td>A previously defined and instantiated <var>HttpRequest</var> object.</td></tr>		<td>A previously defined and instantiated <var>HttpRequest</var> object.</td></tr>
	<tr><th>newLineEnd</th>		<tr><th>newLineEnd</th>
Line 23:		Line 23:
	<li>The <var>LineEnd</var> setting remains in effect unless the property is reset with another assignment.		<li>The <var>LineEnd</var> setting remains in effect unless the property is reset with another assignment.
	<li>For an example of code that uses the <var>LineEnd</var> property, see [[AddField (HttpRequest subroutine)#Example\|this]] <var>AddField</var> example.		<li>For an example of code that uses the <var>LineEnd</var> property, see [[AddField (HttpRequest subroutine)#Example\|this]] <var>AddField</var> example.
	~~<li><var>LineEnd</var> is available in <var class="product">[[Sirius Mods]]</var> Version 6.6 and later.~~
	</ul>		</ul>

	==Example==		==Example==
	~~<ol>~~		The <var>LineEnd</var> format is shown in the following fragment:
	~~<li>~~The <var>LineEnd</var> format is shown in the following fragment:
	<p class="code"> %HttpRequest:LineEnd = CRLF		<p class="code"> %HttpRequest:LineEnd = CRLF
	%HttpRequest:LineEnd = CR		%HttpRequest:LineEnd = CR
	%HttpRequest:LineEnd = LF		%HttpRequest:LineEnd = LF
	%HttpRequest:AddField( ....		%HttpRequest:AddField( ....
	</p~~></ol~~>		</p>

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

Goff: match syntax table to syntax template; edits, tags and links

2011-06-18T09:28:34Z

match syntax table to syntax template; edits, tags and links

← Older revision		Revision as of 09:28, 18 June 2011
Line 1:		Line 1:
	{{Template:HttpRequest:LineEnd subtitle}}		{{Template:HttpRequest:LineEnd subtitle}}
			The <var>LineEnd</var> settable property lets you select which of three line-end sequences to use when you add a file to form Post data by passing a <var>[[Stringlist class\|Stringlist]]</var> object to the <var>[[AddField_(HttpRequest_subroutine)\|AddField]]</var> method.

	~~Added in version 6.6, this settable property~~
	~~lets you select which of three line-end sequences to use~~
	~~when you add a file to form Post data by passing a <var>Stringlist</var> object~~
	~~to the AddField method.~~
	==Syntax==		==Syntax==
	{{Template:HttpRequest:LineEnd syntax}}		{{Template:HttpRequest:LineEnd syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~httpreq~~</th>		<tr><th>%currentLineEnd</th>
	<td>An instantiated <var>HttpRequest</var> object.		<td>The string variable that will be assignment the current value of <var>LineEnd</var>.</td></tr>
	</td></tr>		<tr><th>%httpRequest</th>
	<tr><th>~~sequence~~</th>		<td>A previously defined and instantiated <var>HttpRequest</var> object.</td></tr>
	<td>Identifies the line-end sequence to use for the <var>Stringlist</var> items being copied into the Post data. Each copied <var>Stringlist</var> item has a line-end sequence appended to it. The options you may specify are these LineEnd Enumeration values: <dl> <dt>CRLF <dd>Use carriage-return/line-feed (hex value X'0D0A'). This is the default for a newly created <var>HttpRequest</var> object. <dt>CR <dd>Use only carriage-return (X'0D'). <dt>LF <dd>Use only line-feed (X'0A').		<tr><th>newLineEnd</th>
			<td>Identifies the new line-end sequence to use for the <var>Stringlist</var> items being copied into the Post data. Each copied <var>Stringlist</var> item has a line-end sequence appended to it. The options you may specify are these <var>LineEnd</var> <var>Enumeration</var> values:
			<dl><dt>CRLF <dd>Use carriage-return/line-feed (hex value X'0D0A'). This is the default for a newly created <var>HttpRequest</var> object.
			<dt>CR <dd>Use only carriage-return (X'0D').
			<dt>LF <dd>Use only line-feed (X'0A').
	</dl>		</dl>
	~~</td></tr>~~
	~~<tr><th>%curr</th>~~
	~~<td>The string variable for the assignment of the current value of LineEnd.~~
	</td></tr></table>		</td></tr></table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>The <var>LineEnd</var> property must be set '''before''' the <var>AddField</var> call		<li>The <var>LineEnd</var> property must be set '''before''' the <var>AddField</var> call that adds the form data.
	that adds the form data.		<li>The <var>LineEnd</var> setting remains in effect unless the property is reset with another assignment.
	<li>The <var>LineEnd</var> setting remains in effect		<li>For an example of code that uses the <var>LineEnd</var> property, see [[AddField (HttpRequest subroutine)#Example\|this]] <var>AddField</var> example.
	unless the property is reset with another assignment.		<li><var>LineEnd</var> is available in <var class="product">[[Sirius Mods]]</var> Version 6.6 and later.
	<li>For an example of code that uses the <var>LineEnd</var>
	property, see [[AddField (HttpRequest subroutine)#Example\|this]] <var>AddField</var> example.
	<li>~~For information about~~ <var>~~Enumerations~~</var>~~, see~~ [[~~Enumerations\|"Enumerations"~~]].
	</ul>		</ul>

	==Example==		==Example==
			<ol>
	The <var>LineEnd</var> format is shown in the following fragment:		<li>The <var>LineEnd</var> format is shown in the following fragment:
	<p class="code"> %HttpRequest:LineEnd = CRLF		<p class="code"> %HttpRequest:LineEnd = CRLF
	%HttpRequest:LineEnd = CR		%HttpRequest:LineEnd = CR
	%HttpRequest:LineEnd = LF		%HttpRequest:LineEnd = LF
	%HttpRequest:AddField( ....		%HttpRequest:AddField( ....
	</p>		</p></ol>

	==See also==		==See also==
			<ul><li>For more general information and background about using Enumerations, see [[Enumerations\|"Enumerations"]].
			</ul>
	{{Template:HttpRequest:LineEnd footer}}		{{Template:HttpRequest:LineEnd footer}}

DmeWiccan: 1 revision

2011-06-16T20:17:37Z

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 10:		Line 10:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%httpreq</th>		<tr><th>%httpreq</th>
	<td>An instantiated <var>~~HTTPRequest~~</var> object.		<td>An instantiated <var>HttpRequest</var> object.
	</td></tr>		</td></tr>
	<tr><th>sequence</th>		<tr><th>sequence</th>
	<td>Identifies the line-end sequence to use for the <var>Stringlist</var> items being copied into the Post data. Each copied <var>Stringlist</var> item has a line-end sequence appended to it. The options you may specify are these LineEnd Enumeration values: <dl> <dt>CRLF <dd>Use carriage-return/line-feed (hex value X'0D0A'). This is the default for a newly created <var>~~HTTPRequest~~</var> object. <dt>CR <dd>Use only carriage-return (X'0D'). <dt>LF <dd>Use only line-feed (X'0A').		<td>Identifies the line-end sequence to use for the <var>Stringlist</var> items being copied into the Post data. Each copied <var>Stringlist</var> item has a line-end sequence appended to it. The options you may specify are these LineEnd Enumeration values: <dl> <dt>CRLF <dd>Use carriage-return/line-feed (hex value X'0D0A'). This is the default for a newly created <var>HttpRequest</var> object. <dt>CR <dd>Use only carriage-return (X'0D'). <dt>LF <dd>Use only line-feed (X'0A').
	</dl>		</dl>
	</td></tr>		</td></tr>
Line 27:		Line 27:
	unless the property is reset with another assignment.		unless the property is reset with another assignment.
	<li>For an example of code that uses the <var>LineEnd</var>		<li>For an example of code that uses the <var>LineEnd</var>
	property, see [[AddField (~~HTTPRequest~~ subroutine)#Example\|this]] <var>AddField</var> example.		property, see [[AddField (HttpRequest subroutine)#Example\|this]] <var>AddField</var> example.
	<li>For information about <var>Enumerations</var>, see [[Enumerations\|"Enumerations"]].		<li>For information about <var>Enumerations</var>, see [[Enumerations\|"Enumerations"]].
	</ul>		</ul>
Line 33:		Line 33:

	The <var>LineEnd</var> format is shown in the following fragment:		The <var>LineEnd</var> format is shown in the following fragment:
	<p class="code"> %~~HTTPRequest~~:LineEnd = CRLF		<p class="code"> %HttpRequest:LineEnd = CRLF
	%~~HTTPRequest~~:LineEnd = CR		%HttpRequest:LineEnd = CR
	%~~HTTPRequest~~:LineEnd = LF		%HttpRequest:LineEnd = LF
	%~~HTTPRequest~~:AddField( ....		%HttpRequest:AddField( ....
	</p>		</p>
	==See also==		==See also==
	{{Template:HttpRequest:LineEnd footer}}		{{Template:HttpRequest:LineEnd footer}}

DmeWiccan: 1 revision

2011-06-16T20:16:26Z

1 revision

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

Dme: moved LineEnd (HTTPRequest property) to LineEnd (HttpRequest property)

2011-06-16T20:16:23Z

moved LineEnd (HTTPRequest property) to LineEnd (HttpRequest property)

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

	Added in version 6.6, this settable property		Added in version 6.6, this settable property
Line 6:		Line 6:
	to the AddField method.		to the AddField method.
	==Syntax==		==Syntax==
	{{Template:~~HTTPRequest~~:LineEnd syntax}}		{{Template:HttpRequest:LineEnd syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 39:		Line 39:
	</p>		</p>
	==See also==		==See also==
	{{Template:~~HTTPRequest~~:LineEnd footer}}		{{Template:HttpRequest:LineEnd footer}}

Dme: moved LineEnd (HTTPRequest property) to LineEnd (HttpRequest property)

2011-06-16T19:09:24Z

moved LineEnd (HTTPRequest property) to LineEnd (HttpRequest property)

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