Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

IDSSDBConnectionMap Interface Reference

List of all members.

Detailed Description

A connection map is stores information about how to make a database connection.

In particular it records that a user (or user group) trying to connect to a certain logical database in a certain project will use the given physical connection and login information.

Connection maps are not DSS Objects. Instead, the interface is obtained from other interfaces, such as IDSSProject and IDSSServerDef, as a property. Connection maps are saved as part of other objects such as DSSProject object and DSSServerDef object.


Public Member Functions

HRESULT DBConnection ([in] IDSSDBConnection *pDBConnection)
 Set the information needed to establish the physical connection.
HRESULT DBConnection ([out, retval] IDSSDBConnection ppDBConnection)
 Get the information needed to establish the physical connection.
HRESULT DBLogin ([in] IDSSDBLogin *pDBLogin)
 Set the login name and password used when establishing the physical connection.
HRESULT DBLogin ([out, retval] IDSSDBLogin ppDBLogin)
 Get the login name and password used when establishing the physical connection.
HRESULT DBRole ([in] IDSSDBRole *pDBRole)
 Set the logical database to which the user wants to connect A logical database is represented with a DSS DB Role object.
HRESULT DBRole ([out, retval] IDSSDBRole ppDBRole)
 Get the logical database to which the user wants to connect A logical database is represented with a DSS DB Role object.
HRESULT User ([in] IDSSUser *pUser)
 Set the User or UserGroup that wishes to connect to a database.
HRESULT User ([out, retval] IDSSUser ppUser)
 Get the User or UserGroup that wishes to connect to a database.


Member Function Documentation

HRESULT IDSSDBConnectionMap::DBConnection [in] IDSSDBConnection pDBConnection  ) 
 

Set the information needed to establish the physical connection.

The information is stored in a DSS DB Connection object.

Parameters:
pDBConnection Object handle of a database connection definition.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBConnectionMap::DBConnection [out, retval] IDSSDBConnection   ppDBConnection  ) 
 

Get the information needed to establish the physical connection.

The information is stored in a DSS DB Connection object.

Parameters:
ppDBConnection Object handle of a database connection definition.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBConnectionMap::DBLogin [in] IDSSDBLogin pDBLogin  ) 
 

Set the login name and password used when establishing the physical connection.

A login name and password are stored in a DSS DB Login object.

Parameters:
pDBLogin Object handle of a database login.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBConnectionMap::DBLogin [out, retval] IDSSDBLogin   ppDBLogin  ) 
 

Get the login name and password used when establishing the physical connection.

A login name and password are stored in a DSS DB Login object.

Parameters:
ppDBLogin Object handle of a database login
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBConnectionMap::DBRole [in] IDSSDBRole pDBRole  ) 
 

Set the logical database to which the user wants to connect A logical database is represented with a DSS DB Role object.

Parameters:
pDBRole Object of the logical database
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBConnectionMap::DBRole [out, retval] IDSSDBRole   ppDBRole  ) 
 

Get the logical database to which the user wants to connect A logical database is represented with a DSS DB Role object.

Parameters:
ppDBRole Object of the logical database
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBConnectionMap::User [in] IDSSUser pUser  ) 
 

Set the User or UserGroup that wishes to connect to a database.

The User could be null, which means this is a default mapping that applies to all users except those have their own mapping.

Parameters:
pUser Object handle of the user to whom this mapping applies.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBConnectionMap::User [out, retval] IDSSUser   ppUser  ) 
 

Get the User or UserGroup that wishes to connect to a database.

The User could be null, which means this is a default mapping that applies to all users except those have their own mapping.

Parameters:
ppUser Object handle of the user to whom this mapping applies.
Returns:
Usual COM result code:
  • S_OK


Copyright © 1996-2018 MicroStrategy Inc. All Rights Reserved.