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.
Declaration Syntax
C# | Visual Basic | Visual C++ |
public void AppendRecapMessage( Topic topic, CorrelationID cid )
Public Sub AppendRecapMessage ( topic As Topic, cid As CorrelationID )
public: void AppendRecapMessage( Topic^ topic, CorrelationID^ cid )
Parameters
- topic (Topic)
- the corresponding topic
- cid (CorrelationID)
- 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.
|
Assembly: Bloomberglp.Blpapi (Module: Bloomberglp.Blpapi.dll) Version: 3.8.10.1