Namespace: OpenEdge.Net.HTTP.Filter.Payload
Type: Class XmlBodyWriter
Parent Classes:
Inherits: OpenEdge.Net.HTTP.Filter.Payload.MessageWriter
Implements: OpenEdge.Core.ISupportEncoding


Copyright (c) 2015-2018, 2021 by Progress Software Corporation. All rights reserved.
File:XmlBodyWriter
Author(s):pjudge
Created:Thu Jan 29 10:47:13 EST 2015
Notes:* Supports String, WidgetHandle, Memptr and FileInputStream types but these MUST contain
valid/wellformed XML documents.
/* Content encoding (eg utf-8) used by the implementer



Method Summary
  Options Name Purpose
  Open () /* Opens the writer for work. Will clear the underlying data structure. */
  INT64 Write (handle) /* Writes XML data from a handle. Input data is concatenated to any existing data. @param handle The XML data, as a X-DOCUMENT, BUFFER, TEMP-TABLE or PRODATASET @return int64 The number of bytes written */
  INT64 Write (longchar) /* Writes XML data from character/longchar. Input data is concatenated to any existing data. @param longchar The XML data. Validated as XML by checking for a leading "<" @return int64 The number of bytes written */
  INT64 Write (memptr) /* Writes XML data from a MEMPTR. Input data is concatenated to any existing data. @param memptr The XML data. Validated as XML by checking for a leading "<" @return int64 The number of bytes written */
  INT64 Write (Object) /* Writes XML data from an object representation or wrapper. Input data is concatenated to any existing data. Supported types: - IMemptrHolder: includes OpenEdge.Core.Memptr and .ByteBucket - IHandleHolder - ICharacterHolder, ILongcharHolder - MemoryOutputStream - FileInputStream: must have a XML or XSD extension @param Progress.Lang.Object The XML data @return int64 The number of bytes written */

Constructor Summary
  Options Name Purpose
  XmlBodyWriter () /* Default constructor */

Property Summary
  Options Name Purpose
  CHARACTER Encoding


Method Detail
Top

Open ()

/* Opens the writer for work. Will clear the underlying data structure.
Top

INT64 Write (handle)

/* Writes XML data from a handle. Input data is concatenated to any existing data.
Parameters:
pData HANDLE
 
Returns INT64
  int64 The number of bytes written
Top

INT64 Write (longchar)

/* Writes XML data from character/longchar. Input data is concatenated to any existing data.
Parameters:
pData LONGCHAR
 
Returns INT64
  int64 The number of bytes written
Top

INT64 Write (memptr)

/* Writes XML data from a MEMPTR. Input data is concatenated to any existing data.
Parameters:
pmData MEMPTR
 
Returns INT64
  int64 The number of bytes written
Top

INT64 Write (Object)

/* Writes XML data from an object representation or wrapper. Input data is concatenated to any existing data.
Supported types:
- IMemptrHolder: includes OpenEdge.Core.Memptr and .ByteBucket
- IHandleHolder
- ICharacterHolder, ILongcharHolder
- MemoryOutputStream
- FileInputStream: must have a XML or XSD extension
Parameters:
poData Progress.Lang.Object
 
Returns INT64
  int64 The number of bytes written


Constructor Detail
Top

XmlBodyWriter ()

/* Default constructor


Property Detail
Top

CHARACTER Encoding

Returns CHARACTER