ContentToStringlist (HttpResponse function)

From m204wiki
Jump to: navigation, search

HTTP response data split into lines (HttpResponse class)

The ContentToStringlist method places into a Stringlist object the content returned from an HttpRequest Get, Post, or Send method. ContentToStringlist does the following:

  1. Instantiates a Stringlist object.
  2. Breaks the HttpRequest returned content into lines by scanning for line-ends.
  3. Translates each line from ASCII to EBCDIC, and places it in its own Stringlist element in the Stringlist it created.
  4. Returns the Stringlist.

Syntax

%sl = httpResponse:ContentToStringlist

Syntax terms

%sl A Stringlist object.
httpResponse A reference to an HttpResponse object that was returned by a Get, Post, or Send method of an HttpRequest object.

Usage notes

  • 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).
  • 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 HTTPResponse Content method would leave all the lines in one Longstring, which the application would have to separate into lines using string-handling User Language code.
  • ContentToStringlist is also useful for getting readable output for debugging purposes. For example, you can string together the ContentToStringlist and Print methods:

     %myGradeBookResponse:contentToStringlist:print

    The statement above produces much more readable output than this:

    print %myGradeBookResponse:content

Example

The following code prompts for a URL, fetches the page at that URL, places it in a Stringlist using ContentToStringlist, and displays the lines.

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

See also

  • For information about returning response contents into a Longstring, see Content.