Message.GetCorrelationID Method

MessageGetCorrelationID Method

Returns the correlationId associated with this message at the specified position.

Namespace: Bloomberglp.Blpapi
Assembly: Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.25.11.64-experimental+d519cd77c15f00eb425bcde0dbe3273921f5910b

Syntax

C++

Copy

public abstract CorrelationID GetCorrelationID(
	int position
)

Public MustOverride Function GetCorrelationID ( 
	position As Integer
) As CorrelationID

public:
virtual CorrelationID^ GetCorrelationID(
	int position
) abstract

abstract GetCorrelationID : 
        position : int -> CorrelationID

Parameters

position: Type: SystemInt32
The specified position.

Return Value

Type: CorrelationID
The CorrelationID at the position.

Exceptions

Exception	Condition
IndexOutOfRangeException	index >= NumCorrelationIDs

Remarks

Normally each message is associated with only one correlationId. See "allowMultipeCorrelatorsPerMsg" option in SessionOptions for more information on when multiple correlators can be returned per message.

Reference

Message Class

Bloomberglp.Blpapi Namespace