ISessionSendRequest Method (Request, Identity, IEventQueue, CorrelationID, String) |
Sends a request to a service.
A successful request will generate zero or more
PARTIAL_RESPONSE events followed by
exactly one RESPONSE event. Once the
final RESPONSE event has been
received the CorrelationID associated with this
request may be re-used. If the request fails at any stage a
REQUEST_STATUS event will be generated
after which the CorrelationID associated with the
request may be re-used.
The number of enqueued requests must not exceed the amount specified
in MaxPendingRequests when this session
was created.
Namespace:
Bloomberglp.Blpapi
Assembly:
Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.24.8.1
Syntax CorrelationID SendRequest(
Request request,
Identity identity,
IEventQueue eventQueue,
CorrelationID correlationId,
string requestLabel
)
Function SendRequest (
request As Request,
identity As Identity,
eventQueue As IEventQueue,
correlationId As CorrelationID,
requestLabel As String
) As CorrelationID
CorrelationID^ SendRequest(
Request^ request,
Identity^ identity,
IEventQueue^ eventQueue,
CorrelationID^ correlationId,
String^ requestLabel
)
abstract SendRequest :
request : Request *
identity : Identity *
eventQueue : IEventQueue *
correlationId : CorrelationID *
requestLabel : string -> CorrelationID
Parameters
- request
- Type: Bloomberglp.BlpapiRequest
Filled-in request that needs to be sent to the service.
- identity
- Type: Bloomberglp.BlpapiIdentity
The user whose privileges are to be used for this request.
If null then the session identity will be used if authorized.
- eventQueue
- Type: Bloomberglp.BlpapiIEventQueue
IEventQueue to be used to receive response events for
this request. If null, events for this request are delivered to the
session's event queue.
- correlationId
- Type: Bloomberglp.BlpapiCorrelationID
A CorrelationID to be used to match the response.
If null then an internal CorrelationID is generated.
Must not already be in use.
- requestLabel
- Type: SystemString
A label which will be recorded along with any diagnostics for this
operation.
Return Value
Type:
CorrelationID
The
CorrelationID object that will identify
Message objects generated as a result of this call.
This will be
correlationId if it was provided.
See Also