EventFormatterAppendRecapMessage Method (Topic, CorrelationID) |
Appends a (empty) recap message that will be published under the
specified 'topic' to the event referenced by this
EventFormatter. Specifies
the optional 'cid' if this recap message is added in response to a
'TopicRecap' message. After a message has been appended its
elements can be set using the various 'SetElement' methods. It is
an error to create append a recap message to an admin event.
Namespace:
Bloomberglp.Blpapi
Assembly:
Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.24.11.1
Syntax public void AppendRecapMessage(
Topic topic,
CorrelationID cid
)
Public Sub AppendRecapMessage (
topic As Topic,
cid As CorrelationID
)
public:
void AppendRecapMessage(
Topic^ topic,
CorrelationID^ cid
)
member AppendRecapMessage :
topic : Topic *
cid : CorrelationID -> unit
Parameters
- topic
- Type: Bloomberglp.BlpapiTopic
the corresponding topic - cid
- Type: Bloomberglp.BlpapiCorrelationID
the correlationId of the 'TopicRecap' message if
responding to a recap request or null if this is a recap message
for all subscribers
Exceptions Exception | Condition |
---|
NotFoundException |
There is no recap message in service.
|
InvalidOperationException |
The operating stack is not empty.
|
ArgumentException |
The specified event is not a publish event.
The specified topic is not valid.
|
See Also