blpapi_authoptions.h File Reference

Provides configuration settings for authorization. More...

#include <blpapi_call.h>
#include <blpapi_defs.h>
#include <blpapi_exception.h>
#include <blpapi_types.h>
#include <stddef.h>

Go to the source code of this file.

Classes
class	AuthOptions
class	AuthUser
class	AuthApplication
class	AuthToken

Namespaces
	BloombergLP
	BloombergLP::blpapi

Functions
BLPAPI_EXPORT int	blpapi_AuthOptions_create_default (blpapi_AuthOptions_t **options)
BLPAPI_EXPORT int	blpapi_AuthOptions_create_forUserMode (blpapi_AuthOptions_t **options, const blpapi_AuthUser_t *user)
BLPAPI_EXPORT int	blpapi_AuthOptions_create_forAppMode (blpapi_AuthOptions_t **options, const blpapi_AuthApplication_t *app)
BLPAPI_EXPORT int	blpapi_AuthOptions_create_forUserAndAppMode (blpapi_AuthOptions_t **options, const blpapi_AuthUser_t *user, const blpapi_AuthApplication_t *app)
BLPAPI_EXPORT int	blpapi_AuthOptions_create_forToken (blpapi_AuthOptions_t **options, const blpapi_AuthToken_t *token)
BLPAPI_EXPORT int	blpapi_AuthOptions_duplicate (blpapi_AuthOptions_t **options, const blpapi_AuthOptions_t *dup)
BLPAPI_EXPORT int	blpapi_AuthOptions_copy (blpapi_AuthOptions_t *lhs, const blpapi_AuthOptions_t *rhs)
BLPAPI_EXPORT void	blpapi_AuthOptions_destroy (blpapi_AuthOptions_t *options)
BLPAPI_EXPORT int	blpapi_AuthUser_createWithLogonName (blpapi_AuthUser_t **user)
BLPAPI_EXPORT int	blpapi_AuthUser_createWithActiveDirectoryProperty (blpapi_AuthUser_t **user, const char *propertyName)
BLPAPI_EXPORT int	blpapi_AuthUser_createWithManualOptions (blpapi_AuthUser_t **user, const char *userId, const char *ipAddress)
BLPAPI_EXPORT int	blpapi_AuthUser_duplicate (blpapi_AuthUser_t **user, const blpapi_AuthUser_t *dup)
BLPAPI_EXPORT int	blpapi_AuthUser_copy (blpapi_AuthUser_t *lhs, const blpapi_AuthUser_t *rhs)
BLPAPI_EXPORT void	blpapi_AuthUser_destroy (blpapi_AuthUser_t *user)
BLPAPI_EXPORT int	blpapi_AuthApplication_create (blpapi_AuthApplication_t **app, const char *appName)
BLPAPI_EXPORT int	blpapi_AuthApplication_duplicate (blpapi_AuthApplication_t **app, const blpapi_AuthApplication_t *dup)
BLPAPI_EXPORT int	blpapi_AuthApplication_copy (blpapi_AuthApplication_t *lhs, const blpapi_AuthApplication_t *rhs)
BLPAPI_EXPORT void	blpapi_AuthApplication_destroy (blpapi_AuthApplication_t *app)
BLPAPI_EXPORT int	blpapi_AuthToken_create (blpapi_AuthToken_t **token, const char *tokenStr)
BLPAPI_EXPORT int	blpapi_AuthToken_duplicate (blpapi_AuthToken_t **token, const blpapi_AuthToken_t *dup)
BLPAPI_EXPORT int	blpapi_AuthToken_copy (blpapi_AuthToken_t *lhs, const blpapi_AuthToken_t *rhs)
BLPAPI_EXPORT void	blpapi_AuthToken_destroy (blpapi_AuthToken_t *token)

Detailed Description

Provides configuration settings for authorization.

Function Documentation

blpapi_AuthApplication_copy()

BLPAPI_EXPORT int blpapi_AuthApplication_copy	(	blpapi_AuthApplication_t *	lhs,
		const blpapi_AuthApplication_t *	rhs
	)

blpapi_AuthApplication_create()

BLPAPI_EXPORT int blpapi_AuthApplication_create	(	blpapi_AuthApplication_t **	app,
		const char *	appName
	)

blpapi_AuthApplication_destroy()

BLPAPI_EXPORT void blpapi_AuthApplication_destroy

(

blpapi_AuthApplication_t *

app

)

blpapi_AuthApplication_duplicate()

BLPAPI_EXPORT int blpapi_AuthApplication_duplicate	(	blpapi_AuthApplication_t **	app,
		const blpapi_AuthApplication_t *	dup
	)

blpapi_AuthOptions_copy()

BLPAPI_EXPORT int blpapi_AuthOptions_copy	(	blpapi_AuthOptions_t *	lhs,
		const blpapi_AuthOptions_t *	rhs
	)

blpapi_AuthOptions_create_default()

BLPAPI_EXPORT int blpapi_AuthOptions_create_default

(

blpapi_AuthOptions_t **

options

)

blpapi_AuthOptions_create_forAppMode()

BLPAPI_EXPORT int blpapi_AuthOptions_create_forAppMode	(	blpapi_AuthOptions_t **	options,
		const blpapi_AuthApplication_t *	app
	)

blpapi_AuthOptions_create_forToken()

BLPAPI_EXPORT int blpapi_AuthOptions_create_forToken	(	blpapi_AuthOptions_t **	options,
		const blpapi_AuthToken_t *	token
	)

blpapi_AuthOptions_create_forUserAndAppMode()

BLPAPI_EXPORT int blpapi_AuthOptions_create_forUserAndAppMode	(	blpapi_AuthOptions_t **	options,
		const blpapi_AuthUser_t *	user,
		const blpapi_AuthApplication_t *	app
	)

blpapi_AuthOptions_create_forUserMode()

BLPAPI_EXPORT int blpapi_AuthOptions_create_forUserMode	(	blpapi_AuthOptions_t **	options,
		const blpapi_AuthUser_t *	user
	)

blpapi_AuthOptions_destroy()

BLPAPI_EXPORT void blpapi_AuthOptions_destroy

(

blpapi_AuthOptions_t *

options

)

blpapi_AuthOptions_duplicate()

BLPAPI_EXPORT int blpapi_AuthOptions_duplicate	(	blpapi_AuthOptions_t **	options,
		const blpapi_AuthOptions_t *	dup
	)

blpapi_AuthToken_copy()

BLPAPI_EXPORT int blpapi_AuthToken_copy	(	blpapi_AuthToken_t *	lhs,
		const blpapi_AuthToken_t *	rhs
	)

blpapi_AuthToken_create()

BLPAPI_EXPORT int blpapi_AuthToken_create	(	blpapi_AuthToken_t **	token,
		const char *	tokenStr
	)

blpapi_AuthToken_destroy()

BLPAPI_EXPORT void blpapi_AuthToken_destroy

(

blpapi_AuthToken_t *

token

)

blpapi_AuthToken_duplicate()

BLPAPI_EXPORT int blpapi_AuthToken_duplicate	(	blpapi_AuthToken_t **	token,
		const blpapi_AuthToken_t *	dup
	)

blpapi_AuthUser_copy()

BLPAPI_EXPORT int blpapi_AuthUser_copy	(	blpapi_AuthUser_t *	lhs,
		const blpapi_AuthUser_t *	rhs
	)

blpapi_AuthUser_createWithActiveDirectoryProperty()

BLPAPI_EXPORT int blpapi_AuthUser_createWithActiveDirectoryProperty	(	blpapi_AuthUser_t **	user,
		const char *	propertyName
	)

blpapi_AuthUser_createWithLogonName()

BLPAPI_EXPORT int blpapi_AuthUser_createWithLogonName

(

blpapi_AuthUser_t **

user

)

blpapi_AuthUser_createWithManualOptions()

BLPAPI_EXPORT int blpapi_AuthUser_createWithManualOptions	(	blpapi_AuthUser_t **	user,
		const char *	userId,
		const char *	ipAddress
	)

blpapi_AuthUser_destroy()

BLPAPI_EXPORT void blpapi_AuthUser_destroy

(

blpapi_AuthUser_t *

user

)

blpapi_AuthUser_duplicate()

BLPAPI_EXPORT int blpapi_AuthUser_duplicate	(	blpapi_AuthUser_t **	user,
		const blpapi_AuthUser_t *	dup
	)