Difference between revisions of "Content (HttpResponse function)"

From m204wiki
Jump to navigation Jump to search
m
Line 1: Line 1:
 
{{Template:HttpResponse:Content subtitle}}
 
{{Template:HttpResponse:Content subtitle}}
  
This method lets you access the document/content from Get, Post, and Send
+
This method lets you access the document/content from <var>[[Get (HttpRequest function)|Get]]</var>, <var>[[Post (HttpRequest function)|Post]]</var>, and <var>[[Send (HttpRequest function)|Send]]</var>
 
operations.
 
operations.
Content returns the entire document into a longstring with no parsing:
+
<var>Content</var> returns the entire document into a <var>Longstring</var> with no parsing:
 
you get the raw bytes as they were returned from the HTTP request, with the
 
you get the raw bytes as they were returned from the HTTP request, with the
 
option of ASCII-to-EBCDIC translation.
 
option of ASCII-to-EBCDIC translation.

Revision as of 21:28, 17 June 2011

Get raw HTTP response data (HttpResponse class)


This method lets you access the document/content from Get, Post, and Send operations. Content returns the entire document into a Longstring with no parsing: you get the raw bytes as they were returned from the HTTP request, with the option of ASCII-to-EBCDIC translation.

Syntax

%string = httpResponse:Content[( [number])]

Syntax terms

%longstring A longstring variable.
%httpresp A reference to an HTTPResponse object that was returned by a Get, Post, or Send method of an HTTPRequest object.
binflag A numeric expression that, if nonzero, indicates binary data. Setting this option overrides the default behaviour, which is to translate ASCII data to EBCDIC.

Usage notes

  • Invoke Content only if a successful HTTP transaction has occurred, that is, if the Success value is True. If Content is called after an unsuccessful operation, the request is cancelled.
  • If the content type header indicates HTML, XML, or plain text, ASCII-to-EBCDIC translation is performed. If the Clsock port definition specifies a translation table for ASCII-to-EBCDIC, that table is used instead of the default.

Example

In the following fragment, an HTTPResponse object receives a .PDF file from a remote URL into a Longstring, leaving the data in binary format:

%httpreq is object httpRequest %httpresp is object httpResponse %pdf is longstring %url is longstring ... %httpreq = new %httpreq:url = %url %httpresp = %httpreq:get If (%httpresp:Success) then %pdf = %httpresp:content(1) ...

See also

  • For information about returning response contents into a Stringlist, see the ContentToStringlist method.