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

IDSSDBLogin Interface Reference

List of all members.

Detailed Description

IDSSDBLogin contains the information about a database login, such as login name and password.

It is used in conjunction with a DBConnection object to establish a physical connection to a database.

DSSDBLogin objects are metadata objects. They can be browsed/saved through DSS Object Server.


Public Member Functions

HRESULT Info ([out, retval] IDSSObjectInfo ppInfo)
 Get the standard object information: name, description, and so on.
HRESULT LoginName ([in] BSTR LoginName)
 Get the database login user name.
HRESULT LoginName ([out, retval] BSTR *pLoginName)
 Get the database login user name.
HRESULT Password ([in] BSTR Password)
 Set the database login password.
HRESULT Password ([out, retval] BSTR *pPassword)
 Get the database login password.
HRESULT Populate ([in] IDSSDBLogin *pOriginal)
 Assign properties on this object from another DBLogin object.


Member Function Documentation

HRESULT IDSSDBLogin::Info [out, retval] IDSSObjectInfo   ppInfo  ) 
 

Get the standard object information: name, description, and so on.

Info is an object property. It returns the usual IDSSObjectInfo interface on this object. This interface is used to access things like the name and security permissions on the object.

Parameters:
ppInfo Browsing info of the DB Login
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBLogin::LoginName [in] BSTR  LoginName  ) 
 

Get the database login user name.

LoginName is a text property. We use this name to establish a connection to a database.

LoginName could be different from the display name of IDSSDBLogin. The display name is contained in the Info property and is used in object browsing. In most case, we should make the display name the same as the login name.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBLogin::LoginName [out, retval] BSTR *  pLoginName  ) 
 

Get the database login user name.

LoginName is a text property. We use this name to establish a connection to a database.

LoginName could be different from the display name of IDSSDBLogin. The display name is contained in the Info property and is used in object browsing. In most case, we should make the display name the same as the login name.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBLogin::Password [in] BSTR  Password  ) 
 

Set the database login password.

Password is a text property. It is the string that will be given to the RDBMS as the password when attempting to establish a connection to the database.

This string is encrypted when it is saved into a repository.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBLogin::Password [out, retval] BSTR *  pPassword  ) 
 

Get the database login password.

Password is a text property. It is the string that will be given to the RDBMS as the password when attempting to establish a connection to the database.

This string is encrypted when it is saved into a repository.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDBLogin::Populate [in] IDSSDBLogin pOriginal  ) 
 

Assign properties on this object from another DBLogin object.

Populate is a method. This method assigns the properties inside this object from a given DBLogin object.

Returns:
Usual COM result code:
  • S_OK


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