IMessageFormatter Interface

Used to populate/format a message. It supports writing once only to each field. Attempting to set an already set element will fail.

Behavior is undefined if:

A message formatted with FormatMessageXml(String) is further formatted.
A message formatted with a Set method or an Append method is further formatted using FormatMessageXml(String).

Namespace: Bloomberglp.Blpapi.Test
Assembly: Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.24.6.1

Syntax

C++

Copy

public interface IMessageFormatter

Public Interface IMessageFormatter

public interface class IMessageFormatter

type IMessageFormatter =  interface end

The IMessageFormatter type exposes the following members.

Methods

	Name	Description
	AppendElement	Creates an array element and appends it to the element on which this IMessageFormatter is operating on.
	AppendValue(Boolean)	Appends the specified value to the element on which this IMessageFormatter is operating.
	AppendValue(Char)	Appends the specified value to the element on which this IMessageFormatter is operating.
	AppendValue(Double)	Appends the specified value to the element on which this IMessageFormatter is operating.
	AppendValue(Int32)	Appends the specified value to the element on which this IMessageFormatter is operating.
	AppendValue(Int64)	Appends the specified value to the element on which this IMessageFormatter is operating.
	AppendValue(Single)	Appends the specified value to the element on which this IMessageFormatter is operating.
	AppendValue(String)	Appends the specified value to the element on which this IMessageFormatter is operating.
	AppendValue(Datetime)	Appends the specified value to the element on which this IMessageFormatter is operating.
	AppendValue(Name)	Appends the specified value to the element on which this IMessageFormatter is operating.
	FormatMessageXml	Formats the message from its XML representation. The behavior is undefined if further formatting is done using this IMessageFormatter.
	PopElement	Undoes the most recent call to PushElement(Name) on this IMessageFormatter and returns the context of the IMessageFormatter to where it was before the call to PushElement(Name). Once PopElement has been called it is invalid to attempt to re-visit the same context.
	PushElement	Changes the level at which this IMessageFormatter is operating to the specified element name. The element name must identify either a choice, a sequence or an array at the current level of the schema or the behavior is undefined. After this returns the context of the IMessageFormatter is set to the element name in the schema and any calls to SetElement(Name, Boolean), its overrides, or PushElement(Name) are applied at that level. If name represents an array of scalars then AppendValue(Boolean) or its overrides must be used to add values. If name represents an array of complex types then AppendElement creates the first entry and sets the context of the IMessageFormatter to that element. Calling AppendElement again will create another entry.
	SetElement(Name, Datetime)	Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
	SetElement(Name, Name)	Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
	SetElement(Name, Boolean)	Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
	SetElement(Name, Byte)	Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
	SetElement(Name, Char)	Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
	SetElement(Name, Double)	Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
	SetElement(Name, Int32)	Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
	SetElement(Name, Int64)	Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
	SetElement(Name, Single)	Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
	SetElement(Name, String)	Sets the element with the specified name to the specified value in the current messages referenced by this IMessageFormatter.
	SetElementNull	Creates a null element with the specified name. Note that whether or not fields containing null values are published to subscribers is dependent upon details of the service and the schema configuration.

Top

Reference

Bloomberglp.Blpapi.Test Namespace