Namespace: OpenEdge.Net.HTTP.Filter.Payload
Type: Class XmlEntityWriter
Parent Classes:
Inherits: OpenEdge.Net.HTTP.Filter.Payload.MessageWriter


Copyright (c) 2015, 2018, 2021-2022 by Progress Software Corporation. All rights reserved.
File:XmlEntityWriter
Author(s):pjudge
Created:Thu Jan 29 10:47:13 EST 2015
Notes:- Write() operations are destructive (they replace the existing
Entity).
/* Default constructor



Method Summary
  Options Name Purpose
  HANDLE GetXmlDoc () /* Returns the current X-DOCUMENT handle, or creates one if it does not yet exist/is invalid @return handle A valid X-DOCUMENT handle */
  Open ()
  INT64 Write (character) /** Write data to/from the message @param character Data to write */
  INT64 Write (handle) /** Write data to/from the message. If the handle is a X-DOCUMENT, overwrite any existing data. If the handle is an X-NODEREF, add it to the existing X-DOC. If the document has no root node, then add the noderef as the root node. If a root node exists, then append the node to the root node. If the handle is a DATASET or TEMP-TABLE, call WRITE-XML and replace any existing data If the handle is a BUFFER and it's on a TEMP-TABLE, call WRITE-XML on the table and replace any existing data Otherwise throw an error. @param handle Data to write @return int64 The number of bytes written. Always returns 0 */
  INT64 Write (longchar)
  INT64 Write (memptr)
  INT64 Write (Object)

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

Method Detail
Top

HANDLE GetXmlDoc ()

/* Returns the current X-DOCUMENT handle, or creates one if it does not yet exist/is invalid
Returns HANDLE
  handle A valid X-DOCUMENT handle
Top

Open ()

Top

INT64 Write (character)

Purpose: Write data to/from the message
Parameters:
pcData CHARACTER
 
Returns INT64
 
Top

INT64 Write (handle)

Purpose: Write data to/from the message.
If the handle is a X-DOCUMENT, overwrite any existing data.
If the handle is an X-NODEREF, add it to the existing X-DOC. If the document has no root node, then add the noderef as
the root node. If a root node exists, then append the node to the root node.
If the handle is a DATASET or TEMP-TABLE, call WRITE-XML and replace any existing data
If the handle is a BUFFER and it's on a TEMP-TABLE, call WRITE-XML on the table and replace any existing data
Otherwise throw an error.
Parameters:
phData HANDLE
 
Returns INT64
  int64 The number of bytes written. Always returns 0
Top

INT64 Write (longchar)

Parameters:
pcData LONGCHAR
 
Returns INT64
 
Top

INT64 Write (memptr)

Parameters:
pmData OpenEdge.Core.Memptr
 
Returns INT64
 
Top

INT64 Write (Object)

Parameters:
poData Progress.Lang.Object
 
Returns INT64
 


Constructor Detail
Top

XmlEntityWriter ()

/* Default constructor