| Message Class |
Message objects are used to represent all outputs from the API.
Inheritance HierarchySystemObject
Bloomberglp.BlpapiMessage
Bloomberglp.BlpapiMessage
Namespace: Bloomberglp.Blpapi
Assembly: Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.16.0.1
SyntaxThe Message type exposes the following members.
Constructors
Properties| Name | Description | |
|---|---|---|
 | 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.
|
| IsValid | Return true if the message is valid.
|
| ItemString |
This is the same as calling
GetElement(name).
|
| ItemString, 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.
|
| RecapType |
Gets the recap type of this message.
|
| RequestId |
Gets the request id of the message if one exists, otherwise, null.
When present, the request id can be reported to Bloomberg to troubleshoot the cause of failure messages, or issues with the data contained in the message. Note that request id is not the same as correlation id and should not be used for correlation purposes. |
| 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 DateTime(0) |
| TopicName | Obsolete.
Gets the topic string associated with this message. Returns an empty
string if there is no topic associated with this message.
|
Methods| Name | Description | |
|---|---|---|
 | GetCorrelationID |
Returns the correlationId associated with this message at the specified
position.
|
| GetElement(String) | Returns the element of this message having the specified name.
|
| GetElement(Name) | Returns the element of this message having the specified name.
|
| GetElementAsBool(String) | Returns the value of the element having the specified name as
a boolean value.
|
| GetElementAsBool(Name) | Returns the value of the element having the specified name as
a boolean value.
|
| GetElementAsBytes(String) | Returns the value of the element having the specified name as
a byte array.
|
| GetElementAsBytes(Name) | Returns the value of the element having the specified name as
a byte array.
|
| GetElementAsChar(String) | Returns the value of the element having the specified name as
a char value.
|
| GetElementAsChar(Name) | Returns the value of the element having the specified name as
a char value.
|
| GetElementAsDate(String) | Returns the value of the element having the specified name as
a Date value.
|
| GetElementAsDate(Name) | Returns the value of the element having the specified name as
a Date value.
|
| GetElementAsDatetime(String) | Returns the value of the element having the specified name as
a Datetime value.
|
| GetElementAsDatetime(Name) | Returns the value of the element having the specified name as
a Datetime value.
|
| GetElementAsFloat32(String) | Returns the value of the element having the specified name as
a float value.
|
| GetElementAsFloat32(Name) | Returns the value of the element having the specified name as
a float value.
|
| GetElementAsFloat64(String) | Returns the value of the element having the specified name as
a double value.
|
| GetElementAsFloat64(Name) | Returns the value of the element having the specified name as
a double value.
|
| GetElementAsInt32(String) | Returns the value of the element having the specified name as
an int value.
|
| GetElementAsInt32(Name) | Returns the value of the element having the specified name as
an int value.
|
| GetElementAsInt64(String) | Returns the value of the element having the specified name as
a long value.
|
| GetElementAsInt64(Name) | Returns the value of the element having the specified name as
a long value.
|
| GetElementAsName(String) | Returns the value of the element having the specified name as
a Constant value.
|
| GetElementAsName(Name) | Returns the value of the element having the specified name as
a Constant value.
|
| GetElementAsString(String) | Returns the value of the element having the specified name as
a string value.
|
| GetElementAsString(Name) | Returns the value of the element having the specified name as
a string value.
|
| GetElementAsTime(String) | Returns the value of the element having the specified name as
a Time value.
|
| GetElementAsTime(Name) | Returns the value of the element having the specified name as
a Time value.
|
| HasElement(String) |
Returns true if this message has the element having the specified name
false otherwise.
|
| HasElement(Name) |
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.
|
| HasElement(Name, Boolean) |
Returns true if this message has the element having the specified name
false otherwise.
|
| Print(Stream) | Print the message into the stream.
|
| Print(TextWriter) | Print the message with the help of text writer.
|
| ToString | Return the string representation of this object.
(Overrides ObjectToString.) |
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 SafetyStatic members of this type are safe for multi-threaded operations. Instance members of this type are safe for multi-threaded operations.
See Also