AuthUser Class Reference

#include <blpapi_authoptions.h>

Public Member Functions
	AuthUser (blpapi_AuthUser_t *handle)
	AuthUser (const AuthUser &user)
	~AuthUser ()
AuthUser &	operator= (const AuthUser &rhs)
const blpapi_AuthUser_t *	handle () const

Static Public Member Functions
static AuthUser	createWithLogonName ()
static AuthUser	createWithActiveDirectoryProperty (const char *propertyName)
static AuthUser	createWithManualOptions (const char *userId, const char *ipAddress)

Detailed Description

Contains user-specific authorization options.

See Component blpapi_authoptions

Constructor & Destructor Documentation

AuthUser() [1/2]

AuthUser ( blpapi_AuthUser_t *  handle )

explicit

For internal use only.

AuthUser() [2/2]

AuthUser

(

const AuthUser &

user

)

Copy constructor.

~AuthUser()

~AuthUser

(

)

Destructor.

Member Function Documentation

createWithActiveDirectoryProperty()

AuthUser createWithActiveDirectoryProperty ( const char *  propertyName )

static

Create an AuthUser configured for Active Directory authorization mode (DIRECTORY_SERVICE).

The behavior is undefined when propertyName is NULL or empty.

createWithLogonName()

AuthUser createWithLogonName ( )

static

Create an AuthUser configured for Operating System Login (Domain\User) authorization mode (OS_LOGON).

createWithManualOptions()

AuthUser createWithManualOptions ( const char *  userId, const char *  ipAddress  )

static

Create an AuthUser configured for manual authorization.

The behavior is undefined when either userId or ipAddress is NULL or empty.

handle()

const blpapi_AuthUser_t * handle

(

)

const

For internal use only.

operator=()

AuthUser & operator=

(

const AuthUser &

rhs

)

Assign to this object the value of the specified rhs object.

---

The documentation for this class was generated from the following file:

• blpapi_authoptions.h