Bloomberg API for .NET
Message Class
NamespacesBloomberglp.BlpapiMessage
Message objects are used to represent all outputs from the API.
Declaration Syntax
C#Visual BasicVisual C++
public abstract class Message
Public MustInherit Class Message
public ref class Message abstract
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
Message()()()()
Initializes a new instance of the Message class

AsElement
Gets the contents of this Message as a read-only Element.

CorrelationID
Gets the correlationId associated with this message.

CorrelationIDs
Gets an enumerable collection of all collectionIds associated with this message.

Elements
Gets the enumerable collection of elements.

FragmentType
Gets the fragment type of this message.

GetCorrelationID(Int32)
Returns the correlationId associated with this message at the specified position.

GetElement(Name)
Returns the element of this message having the specified name.

GetElement(String)
Returns the element of this message having the specified name.

GetElementAsBool(Name)
Returns the value of the element having the specified name as a boolean value.

GetElementAsBool(String)
Returns the value of the element having the specified name as a boolean value.

GetElementAsBytes(Name)
Returns the value of the element having the specified name as a byte array.

GetElementAsBytes(String)
Returns the value of the element having the specified name as a byte array.

GetElementAsChar(Name)
Returns the value of the element having the specified name as a char value.

GetElementAsChar(String)
Returns the value of the element having the specified name as a char value.

GetElementAsDate(Name)
Returns the value of the element having the specified name as a Date value.

GetElementAsDate(String)
Returns the value of the element having the specified name as a Date value.

GetElementAsDatetime(Name)
Returns the value of the element having the specified name as a Datetime value.

GetElementAsDatetime(String)
Returns the value of the element having the specified name as a Datetime value.

GetElementAsFloat32(Name)
Returns the value of the element having the specified name as a float value.

GetElementAsFloat32(String)
Returns the value of the element having the specified name as a float value.

GetElementAsFloat64(Name)
Returns the value of the element having the specified name as a double value.

GetElementAsFloat64(String)
Returns the value of the element having the specified name as a double value.

GetElementAsInt32(Name)
Returns the value of the element having the specified name as an int value.

GetElementAsInt32(String)
Returns the value of the element having the specified name as an int value.

GetElementAsInt64(Name)
Returns the value of the element having the specified name as a long value.

GetElementAsInt64(String)
Returns the value of the element having the specified name as a long value.

GetElementAsName(Name)
Returns the value of the element having the specified name as a Constant value.

GetElementAsName(String)
Returns the value of the element having the specified name as a Constant value.

GetElementAsString(Name)
Returns the value of the element having the specified name as a string value.

GetElementAsString(String)
Returns the value of the element having the specified name as a string value.

GetElementAsTime(Name)
Returns the value of the element having the specified name as a Time value.

GetElementAsTime(String)
Returns the value of the element having the specified name as a Time value.

HasElement(Name)
Returns true if this message has the element having the specified name false otherwise.

HasElement(Name, Boolean)
Returns true if this message has the element having the specified name false otherwise.

HasElement(String)
Returns true if this message has the element having the specified name false otherwise.

HasElement(String, Boolean)
Returns true if this message has the element having the specified name false otherwise.

IsValid
Item[([( String])])
This is the same as calling GetElement(name).

Item[([( String, Int32])])
This is the same as calling GetElement(name). GetValue(index).

MessageType
Gets the Name constant representing the type of the message.

NumCorrelationIDs
Gets the number of correlation ids associated with this message.

NumElements
Gets the number of elements contained by this message.

Print(Stream)
Print(TextWriter)
Service
Gets the Service associated with this message. Returns null if this method is not associated with a service.

TimeReceived
Gets the timestamp in System.DateTime in UTC, when the message was received by the library. The value is
 Copy imageCopy
DateTime(0)
if the timestamp is not present.

TopicName
Gets the topic string associated with this message. Returns an empty string if there is no topic associated with this message.

ToString()()()() (Overrides Object.ToString()()()().)
Remarks
Message objects are used to represent all outputs from the API including subscription data, response, administrative and status messages. Message objects are obtained from Event.GetMessages(). A message always has a message type and may optionally contain the following
TopicName
Valid for Subscription data messages.
Service
The service from which this message was received from.
CorrelationId
One or more correlationIds if this message was delivered for a pending request or a subscription.

A Message object is a handle to a single underlying protocol message. The Message contents are represented as an Element and some convenient shortcuts are supplied to the Element accessors.

Thread Safety
Static members of this type are safe for multi-threaded operations. Instance members of this type are safe for multi-threaded operations.
Inheritance Hierarchy
Object
Message

Assembly: Bloomberglp.Blpapi (Module: Bloomberglp.Blpapi.dll) Version: 3.8.10.1