ContentToStringlist (HttpResponse function) - Revision history

JAL: /* Usage notes */

2012-10-10T20:45:56Z

Usage notes

← Older revision		Revision as of 20:45, 10 October 2012
Line 23:		Line 23:
	<ul>		<ul>
	<li>No single <var>HTTPResponse</var> content line may exceed 6124 bytes in length (excluding the line end), or the request is cancelled. The scanned-for line-ends are the three typical characters (<code>CRLF</code>, <code>CR</code>, <code>LF</code>).		<li>No single <var>HTTPResponse</var> content line may exceed 6124 bytes in length (excluding the line end), or the request is cancelled. The scanned-for line-ends are the three typical characters (<code>CRLF</code>, <code>CR</code>, <code>LF</code>).
	<li>This method is useful when the content returned from the HTTP server is a series of ASCII text lines separated by line-end characters (for example, an HTML document). Accessing such content with the <var>HTTPResponse</var> <var>[[Content (HttpResponse function)\|Content]]</var> method would leave all the lines in one <var>Longstring</var>, which the application would have to separate into lines using string-handling User Language code.		<li>This method is useful when the content returned from the HTTP server is a series of ASCII text lines separated by line-end characters (for example, an HTML document). Accessing such content with the <var>HTTPResponse</var> <var>[[Content (HttpResponse function)\|Content]]</var> method would leave all the lines in one <var>Longstring</var>, which the application would have to separate into lines using string-handling <var class="product">User Language</var> code.
	<li><var>ContentToStringlist</var> is also useful for getting readable output for debugging purposes. For example, you can string together the <var>ContentToStringlist</var> and <var>[[Print (HttpResponse subroutine)\|Print]]</var> methods:		<li><var>ContentToStringlist</var> is also useful for getting readable output for debugging purposes. For example, you can string together the <var>ContentToStringlist</var> and <var>[[Print (HttpResponse subroutine)\|Print]]</var> methods:
	<p class="code"> %myGradeBookResponse:contentToStringlist:print		<p class="code"> %myGradeBookResponse:contentToStringlist:print

JAL2 at 19:50, 20 June 2011

2011-06-20T19:50:22Z

← Older revision		Revision as of 19:50, 20 June 2011
Line 1:		Line 1:
	{{Template:HttpResponse:ContentToStringlist subtitle}}		{{Template:HttpResponse:ContentToStringlist subtitle}}
	The <var>ContentToStringlist</var> method places into a <var>[[Stringlist_class\|~~stringlist~~]]</var> object the content returned from an <var>[[HttpRequest class\|HttpRequest]]</var> <var>[[Get (HttpRequest function)\|Get]]</var>, <var>[[Post (HttpRequest function)\|Post]]</var>, or <var>[[Send (HttpRequest function)\|Send]]</var> method.		The <var>ContentToStringlist</var> method places into a <var>[[Stringlist_class\|Stringlist]]</var> object the content returned from an <var>[[HttpRequest class\|HttpRequest]]</var> <var>[[Get (HttpRequest function)\|Get]]</var>, <var>[[Post (HttpRequest function)\|Post]]</var>, or <var>[[Send (HttpRequest function)\|Send]]</var> method.
	<var>ContentToStringlist</var> does the following:		<var>ContentToStringlist</var> does the following:
	<ol>		<ol>
Line 33:		Line 33:

	==Example==		==Example==
	~~<ol>~~		The following code prompts for a URL, fetches the page at that URL, places it in a <var>Stringlist</var> using <var>ContentToStringlist</var>, and displays the lines.
	~~<li>~~The following code prompts for a URL, fetches the page at that URL, places it in a <var>Stringlist</var> using <var>ContentToStringlist</var>, and displays the lines.
	<p class="code">begin		<p class="code">begin
	%httpRequest is object httpRequest		%httpRequest is object httpRequest
Line 60:		Line 59:
	end if		end if
	end		end
	</p~~></ol~~>		</p>

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

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

2011-06-19T05:46:18Z

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

← Older revision		Revision as of 05:46, 19 June 2011
Line 1:		Line 1:
	{{Template:HttpResponse:ContentToStringlist subtitle}}		{{Template:HttpResponse:ContentToStringlist subtitle}}
			The <var>ContentToStringlist</var> method places into a <var>[[Stringlist_class\|stringlist]]</var> object the content returned from an <var>[[HttpRequest class\|HttpRequest]]</var> <var>[[Get (HttpRequest function)\|Get]]</var>, <var>[[Post (HttpRequest function)\|Post]]</var>, or <var>[[Send (HttpRequest function)\|Send]]</var> method.
	~~This~~ method
	places into a ~~Stringlist~~ object the content returned
	from an <var>[[HttpRequest class\|HttpRequest]]</var> <var>[[Get (HttpRequest function)\|Get]]</var>, <var>[[Post (HttpRequest function)\|Post]]</var>, or <var>[[Send (HttpRequest function)\|Send]]</var> method.
	<var>ContentToStringlist</var> does the following:		<var>ContentToStringlist</var> does the following:
	<ol>		<ol>
	<li>Instantiates a <var>Stringlist</var> object.		<li>Instantiates a <var>Stringlist</var> object.
	<li>Breaks the <var>HttpRequest</var> returned content into lines by scanning for line-ends.		<li>Breaks the <var>HttpRequest</var> returned content into lines by scanning for line-ends.
	<li>Translates each line from ASCII to EBCDIC, and places it in its own		<li>Translates each line from ASCII to EBCDIC, and places it in its own <var>Stringlist</var> element in the <var>Stringlist</var> it created.
	<var>Stringlist</var> element in the <var>Stringlist</var> it created.
	<li>Returns the <var>Stringlist</var>.		<li>Returns the <var>Stringlist</var>.
	</ol>		</ol>

	==Syntax==		==Syntax==
	{{Template:HttpResponse:ContentToStringlist syntax}}		{{Template:HttpResponse:ContentToStringlist syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~lines~~</th>		<tr><th>%sl</th>
	<td>A Stringlist object.		<td>A <var>Stringlist</var> object.</td></tr>
			<tr><th>httpResponse</th>
			<td>A reference to an <var>[[HttpResponse_class\|HttpResponse]]</var> object that was returned by a <var>Get</var>, <var>Post</var>, or <var>Send</var> method of an <var>[[HttpRequest_class\|HttpRequest]]</var> object.
	</td></tr>		</td></tr>
	~~<tr><th>%httpresp</th>~~		</table>
	~~<td>A reference to an HTTPResponse object that was returned by a Get, Post, or Send method of an HTTPRequest object.~~

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

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>No single HTTPResponse content line may exceed 6124 bytes in length		<li>No single <var>HTTPResponse</var> content line may exceed 6124 bytes in length (excluding the line end), or the request is cancelled. The scanned-for line-ends are the three typical characters (<code>CRLF</code>, <code>CR</code>, <code>LF</code>).
	(excluding the line end), or the request is cancelled.		<li>This method is useful when the content returned from the HTTP server is a series of ASCII text lines separated by line-end characters (for example, an HTML document). Accessing such content with the <var>HTTPResponse</var> <var>[[Content (HttpResponse function)\|Content]]</var> method would leave all the lines in one <var>Longstring</var>, which the application would have to separate into lines using string-handling User Language code.
	The scanned-for line-ends are the three typical characters (CRLF, CR, LF).		<li><var>ContentToStringlist</var> is also useful for getting readable output for debugging purposes. For example, you can string together the <var>ContentToStringlist</var> and <var>[[Print (HttpResponse subroutine)\|Print]]</var> methods:
	<li>This method is useful when the content returned from the HTTP
	server is a series of ASCII text lines separated by line-end
	characters (for example, an HTML document).
	Accessing such content with the <var>HTTPResponse</var>
	<var>[[Content (HttpResponse function)\|Content]]</var> method
	would leave all the lines in one <var>Longstring</var>, which the application
	would have to separate into lines using string-handling User Language code.
	<li><var>ContentToStringlist</var> is also useful for
	getting readable output for debugging purposes.
	For example, you can string together the <var>ContentToStringlist</var> and
	<var>[[Print (HttpResponse subroutine)\|Print]]</var> methods:
	<p class="code"> %myGradeBookResponse:contentToStringlist:print		<p class="code"> %myGradeBookResponse:contentToStringlist:print
	</p>		</p>
Line 48:		Line 33:

	==Example==		==Example==
			<ol>
	The following code prompts for a URL,		<li>The following code prompts for a URL, fetches the page at that URL, places it in a <var>Stringlist</var> using <var>ContentToStringlist</var>, and displays the lines.
	fetches the page at that URL, places it in a <var>Stringlist</var> using		<p class="code">begin
	<var>ContentToStringlist</var>, and displays the lines.		%httpRequest is object httpRequest
	<p class="code"> begin		%httpResponse is object httpResponse
			%myPage is object stringlist
	%~~HTTPRequest~~ is object ~~HTTPRequest~~
	%~~HTTPResponse~~ is object ~~HTTPResponse~~
	%myPage is object ~~Stringlist~~
	%i is float		%i is float

	%~~HTTPRequest~~ = new		%httpRequest = [[New_(HttpRequest_constructor)\|new]]
	%~~HTTPRequest~~:~~URL~~ = $read('Hey Moe, give me a URL!')		%httpRequest:[[URL_(HttpRequest_property)\|url]] = $read('Hey Moe, give me a URL!')
	%~~HTTPResponse~~ = %~~HTTPRequest~~:~~Get~~('XMLCLIENT', 0 )		%httpResponse = %httpRequest:[[Get_(HttpRequest_function)\|get]]('XMLCLIENT', 0 )
	if ( %httpResponse is null ) then		if ( %httpResponse is null ) then
	print 'Could not connect'		print 'Could not connect'
Line 67:		Line 49:
	end if		end if

	if ( %~~HTTPResponse~~:Code = 200 ) then		if ( %httpResponse:Code = 200 ) then
	%myPage = %~~HTTPResponse~~:~~ContentToStringlist~~		%myPage = %httpResponse:contentToStringlist
	print %myPage:~~Count~~ and 'lines obtained.'		print %myPage:[[Count_(Stringlist_function)\|count]] and 'lines obtained.'
	for %i from 1 to %myPage:count		for %i from 1 to %myPage:count
	print 'Line' and %i and ': ' and %myPage:item(%i) at 15		print 'Line' and %i and ': ' and %myPage:item(%i) at 15
Line 75:		Line 57:
	else		else
	print 'Sorry dude, you got an error: ' and -		print 'Sorry dude, you got an error: ' and -
	%~~HTTPResponse~~:statusline		%httpResponse:[[StatusLine_(HttpResponse_function)\|statusline]]
	end if		end if
	end		end
	</p>		</p></ol>

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

	<ul>		<ul>
	<li>For information about returning response contents into a <var>Longstring</var>,		<li>For information about returning response contents into a <var>Longstring</var>, see <var>[[Content (HttpResponse function)\|Content]]</var>.
	see <var>[[Content (HttpResponse function)\|Content]]</var>.
	</ul>		</ul>
	{{Template:HttpResponse:ContentToStringlist footer}}		{{Template:HttpResponse:ContentToStringlist footer}}

JAL2 at 21:37, 17 June 2011

2011-06-17T21:37:52Z

← Older revision		Revision as of 21:37, 17 June 2011
Line 3:		Line 3:
	This method		This method
	places into a Stringlist object the content returned		places into a Stringlist object the content returned
	from an ~~HTTPRequest~~ <var>[[Get (HttpRequest function)\|Get]]</var>, <var>[[Post (HttpRequest function)\|Post]]</var>, or <var>[[Send (HttpRequest function)\|Send]]</var> method.		from an <var>[[HttpRequest class\|HttpRequest]]</var> <var>[[Get (HttpRequest function)\|Get]]</var>, <var>[[Post (HttpRequest function)\|Post]]</var>, or <var>[[Send (HttpRequest function)\|Send]]</var> method.
	ContentToStringlist does the following:		<var>ContentToStringlist</var> does the following:
	<ol>		<ol>
	<li>Instantiates a Stringlist object.		<li>Instantiates a <var>Stringlist</var> object.
	<li>Breaks the ~~HTTPRequest~~ returned content into lines by scanning for line-ends.		<li>Breaks the <var>HttpRequest</var> returned content into lines by scanning for line-ends.
	<li>Translates each line from ASCII to EBCDIC, and places it in its own		<li>Translates each line from ASCII to EBCDIC, and places it in its own
	Stringlist element in the Stringlist it created.		<var>Stringlist</var> element in the <var>Stringlist</var> it created.
	<li>Returns the Stringlist.		<li>Returns the <var>Stringlist</var>.
	</ol>		</ol>
	==Syntax==		==Syntax==
Line 39:		Line 39:
	getting readable output for debugging purposes.		getting readable output for debugging purposes.
	For example, you can string together the <var>ContentToStringlist</var> and		For example, you can string together the <var>ContentToStringlist</var> and
	<var>[[Print (~~HTTPRequest~~ subroutine)\|Print]]</var> methods:		<var>[[Print (HttpResponse subroutine)\|Print]]</var> methods:
	<p class="code"> %myGradeBookResponse:contentToStringlist:print		<p class="code"> %myGradeBookResponse:contentToStringlist:print
	</p>		</p>
Line 80:		Line 80:
	</p>		</p>
	==See also==		==See also==
	~~{{Template:HttpResponse:ContentToStringlist footer}}~~
	<ul>		<ul>
	<li>For information about returning response contents into a <var>Longstring</var>,		<li>For information about returning response contents into a <var>Longstring</var>,
	see <var>[[Content (HttpResponse function)\|Content]]</var>.		see <var>[[Content (HttpResponse function)\|Content]]</var>.
	</ul>		</ul>
			{{Template:HttpResponse:ContentToStringlist footer}}

JALWiccan: 1 revision

2011-06-17T21:31:02Z

1 revision

← Older revision	Revision as of 21:31, 17 June 2011
(No difference)

JAL2 at 21:31, 17 June 2011

2011-06-17T21:31:02Z

← Older revision		Revision as of 21:31, 17 June 2011
Line 1:		Line 1:
	~~<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>~~		{{Template:HttpResponse:ContentToStringlist subtitle}}
	~~[[Category~~:HttpResponse ~~methods\|ContentToStringlist function]]~~
	~~<p>~~
	~~<var>~~ContentToStringlist~~</var> is a member of the <var>[[HttpResponse class\|HttpResponse]]</var> class.~~
	~~</p>~~

	This method		This method
Line 17:		Line 13:
	</ol>		</ol>
	==Syntax==		==Syntax==
	~~<p class="syntax">%lines = %httpresp~~:ContentToStringlist		{{Template:HttpResponse:ContentToStringlist syntax}}
	~~</p>~~

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 30:		Line 24:
	</td></tr></table>		</td></tr></table>

	==Usage ~~Notes~~==		==Usage notes==
	<ul>		<ul>
	<li>No single HTTPResponse content line may exceed 6124 bytes in length		<li>No single HTTPResponse content line may exceed 6124 bytes in length
Line 85:		Line 79:
	end		end
	</p>		</p>
	==See ~~Also~~==		==See also==
			{{Template:HttpResponse:ContentToStringlist footer}}
	<ul>		<ul>
	<li>For information about returning response contents into a <var>Longstring</var>,		<li>For information about returning response contents into a <var>Longstring</var>,
	see <var>[[Content (HttpResponse function)\|Content]]</var>.		see <var>[[Content (HttpResponse function)\|Content]]</var>.
	</ul>		</ul>

JAL2 at 21:30, 17 June 2011

2011-06-17T21:30:33Z

← Older revision		Revision as of 21:30, 17 June 2011
Line 1:		Line 1:

	<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>		<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
	[[Category:HttpResponse methods\|ContentToStringlist function]]		[[Category:HttpResponse methods\|ContentToStringlist function]]
Line 8:		Line 7:
	This method		This method
	places into a Stringlist object the content returned		places into a Stringlist object the content returned
	from an HTTPRequest Get, Post, or Send method.		from an HTTPRequest <var>[[Get (HttpRequest function)\|Get]]</var>, <var>[[Post (HttpRequest function)\|Post]]</var>, or <var>[[Send (HttpRequest function)\|Send]]</var> method.
	ContentToStringlist does the following:		ContentToStringlist does the following:
	<ol>		<ol>

Admin: 1 revision

2011-06-17T19:37:12Z

1 revision

← Older revision	Revision as of 19:37, 17 June 2011
(No difference)

198.242.244.47: Created page with "
ContentToStringlist function
`ContentToStringlist`
2011-06-17T19:21:21Z

Created page with " <span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span> ContentToStringlist function <p> <var>ContentToStringlist</v..."

New page

<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
[[Category:HttpResponse methods|ContentToStringlist function]]
<p>
<var>ContentToStringlist</var> is a member of the <var>[[HttpResponse class|HttpResponse]]</var> class.
</p>

This method
places into a Stringlist object the content returned
from an HTTPRequest Get, Post, or Send method.
ContentToStringlist does the following:
<ol>
<li>Instantiates a Stringlist object.
<li>Breaks the HTTPRequest returned content into lines by scanning for line-ends.
<li>Translates each line from ASCII to EBCDIC, and places it in its own
Stringlist element in the Stringlist it created.
<li>Returns the Stringlist.
</ol>
==Syntax==
<p class="syntax">%lines = %httpresp:ContentToStringlist
</p>

===Syntax terms===
<table class="syntaxTable">
<tr><th>%lines</th>
<td>A Stringlist object.
</td></tr>
<tr><th>%httpresp</th>
<td>A reference to an HTTPResponse object that was returned by a Get, Post, or Send method of an HTTPRequest object.

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

==Usage Notes==
<ul>
<li>No single HTTPResponse content line may exceed 6124 bytes in length
(excluding the line end), or the request is cancelled.
The scanned-for line-ends are the three typical characters (CRLF, CR, LF).
<li>This method is useful when the content returned from the HTTP
server is a series of ASCII text lines separated by line-end
characters (for example, an HTML document).
Accessing such content with the <var>HTTPResponse</var>
<var>[[Content (HttpResponse function)|Content]]</var> method
would leave all the lines in one <var>Longstring</var>, which the application
would have to separate into lines using string-handling User Language code.
<li><var>ContentToStringlist</var> is also useful for
getting readable output for debugging purposes.
For example, you can string together the <var>ContentToStringlist</var> and
<var>[[Print (HTTPRequest subroutine)|Print]]</var> methods:
<p class="code"> %myGradeBookResponse:contentToStringlist:print
</p>
The statement above produces much more readable output than this:
<p class="code"> print %myGradeBookResponse:content
</p>
</ul>

==Example==

The following code prompts for a URL,
fetches the page at that URL, places it in a <var>Stringlist</var> using
<var>ContentToStringlist</var>, and displays the lines.
<p class="code"> begin

%HTTPRequest is object HTTPRequest
%HTTPResponse is object HTTPResponse
%myPage is object Stringlist
%i is float

%HTTPRequest = new
%HTTPRequest:URL = $read('Hey Moe, give me a URL!')
%HTTPResponse = %HTTPRequest:Get('XMLCLIENT', 0 )
if ( %httpResponse is null ) then
print 'Could not connect'
stop
end if

if ( %HTTPResponse:Code = 200 ) then
%myPage = %HTTPResponse:ContentToStringlist
print %myPage:Count and 'lines obtained.'
for %i from 1 to %myPage:count
print 'Line' and %i and ': ' and %myPage:item(%i) at 15
end for
else
print 'Sorry dude, you got an error: ' and -
%HTTPResponse:statusline
end if
end
</p>
==See Also==
<ul>
<li>For information about returning response contents into a <var>Longstring</var>,
see <var>[[Content (HttpResponse function)|Content]]</var>.
</ul>