HttpObjectGetStatusReport

function

Library: HTTP support (OMHTTP)
Include: omhttp.xin

Declaration

define function HttpObjectGetStatusReport
         read-only  stream HttpObject
   into  modifiable stream Report

Argument definitions

HttpObject: is an HTTP request or HTTP response object (input argument).

Report: is a stream shelf in which error descriptions are stored, with one error per item. The shelf is cleared before the error messages are added (output argument).

Purpose

Use HttpObjectGetStatusReport to write to the "Report" stream argument the descriptions of any errors encountered during the last function using the specified object.

Requirements

You must include the following line at the beginning of your OmniMark program:

  include "omhttp.xin"

Usage Notes

If no errors are encountered, "Report" will contain no items. HttpObjectGetStatusReport is used in either client or server programs.

Example

  ; HttpObjectGetStatusReport
  include "omhttp.xin"
  
  process
  
     local HttpRequest my-Request
     local HttpResponse my-Response
     local stream request-Report variable
     local stream response-Report variable
  
     HttpObjectGetStatusReport my-Request into request-Report
     HttpObjectGetStatusReport my-Response into response-Report
  
     repeat over request-Report
        output "%g(request-Report)%n"
     again
     repeat over response-Report
        output "%g(response-Report)%n"
  again

Related Topics

HttpObjectIsInError

Other Library Functions