SessionOptionsSetSessionIdentityOptions Method |
Sets the specified
authOptions as the
AuthOptions for the session identity, enabling
automatic authorization of the session identity during startup.
The session identity lifetime is tied to the session's lifetime,
so it is guaranteed that the session identity will remain authorized
during the entire duration of the session. The identity will be
authorized before the session starts. The session will terminate
if the identity fails to authorize or is revoked.
The session identity is used to send requests and make subscriptions
if no other identity is provided.
By default the session identity is not authorized.
Namespace:
Bloomberglp.Blpapi
Assembly:
Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.24.11.1
Syntax public CorrelationID SetSessionIdentityOptions(
AuthOptions authOptions,
CorrelationID correlationId = null
)
Public Function SetSessionIdentityOptions (
authOptions As AuthOptions,
Optional correlationId As CorrelationID = Nothing
) As CorrelationID
public:
CorrelationID^ SetSessionIdentityOptions(
AuthOptions^ authOptions,
CorrelationID^ correlationId = nullptr
)
member SetSessionIdentityOptions :
authOptions : AuthOptions *
?correlationId : CorrelationID
(* Defaults:
let _correlationId = defaultArg correlationId null
*)
-> CorrelationID
Parameters
- authOptions
- Type: Bloomberglp.BlpapiAuthOptions
The type of authorization to use.
- correlationId (Optional)
- Type: Bloomberglp.BlpapiCorrelationID
This optional parameter is used to identify messages
associated with the session identity.
Return Value
Type:
CorrelationID
The actual
CorrelationID object that will identify
those events.
See Also