AbstractSession.GenerateAuthorizedIdentity Method

AbstractSessionGenerateAuthorizedIdentity Method

Generates an authorized Identity with the specified authOptions and cid.

One or more AUTHORIZATION_STATUS events, zero or more TOKEN_STATUS events and zero or more SERVICE_STATUS events are generated. If this is an asynchronous AbstractSession then an Event may be processed by the registered EventHandler before GenerateAuthorizedIdentity(AuthOptions, CorrelationID) has returned.

The behavior is undefined when authOptions is null.

Namespace: Bloomberglp.Blpapi
Assembly: Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.24.11.1

Syntax

C++

Copy

public CorrelationID GenerateAuthorizedIdentity(
	AuthOptions authOptions,
	CorrelationID cid = null
)

Public Function GenerateAuthorizedIdentity ( 
	authOptions As AuthOptions,
	Optional cid As CorrelationID = Nothing
) As CorrelationID

public:
virtual CorrelationID^ GenerateAuthorizedIdentity(
	AuthOptions^ authOptions, 
	CorrelationID^ cid = nullptr
) sealed

abstract GenerateAuthorizedIdentity : 
        authOptions : AuthOptions * 
        ?cid : CorrelationID 
(* Defaults:
        let _cid = defaultArg cid null
*)
-> CorrelationID 
override GenerateAuthorizedIdentity : 
        authOptions : AuthOptions * 
        ?cid : CorrelationID 
(* Defaults:
        let _cid = defaultArg cid null
*)
-> CorrelationID

Parameters

authOptions: Type: Bloomberglp.BlpapiAuthOptions
The AuthOptions with which the Identity will be generated.
cid (Optional): Type: Bloomberglp.BlpapiCorrelationID
If provided will be used to identify messages associated with the generated identity.

Return Value

Type: CorrelationID
The CorrelationID object that will be used to identify messages associated with the generated identity. This will be cid if it was provided.

Implements

IAbstractSessionGenerateAuthorizedIdentity(AuthOptions, CorrelationID)

Reference

AbstractSession Class

Bloomberglp.Blpapi Namespace