Class: TSQLLogonStep

Declaration: SQLDataAccess.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

This concrete class defines a unit of logon interaction in an extended logon sequence. Logging on to a database server in a client server environment can require multiple user/password pairs to pass various layers of authentication as implemented by different hosts, DBMSs, and so forth. The interpretation of a particular logon step is the responsibility of the connection object.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSQLLogonStep::TSQLLogonStep

TSQLLogonStep (const TText & name =TStandardText :: GetEmptyText (), const TText & user =TStandardText :: GetEmptyText (), const TText & password =TStandardText :: GetEmptyText (), const TText & other1 =TStandardText :: GetEmptyText (), const TText & other2 =TStandardText :: GetEmptyText (), const TText & other3 =TStandardText :: GetEmptyText (), const TText & other4 =TStandardText :: GetEmptyText ())
TSQLLogonStep (const TSQLLogonStep &)

Interface Category:

API.

Purpose:

Constructs a logon step with the specified parameters.
Copy constructor.

Calling Context:

Call this function directly.
Called to copy an object.

Parameters:

const TText & name =TStandardText :: GetEmptyText () -The name of a logon step. Can be used to specify such things as database name, host name, and so forth.
const TText & user =TStandardText :: GetEmptyText () -The user name of a logon step. This will have different meanings according to the particular logon step (for example, host user or DBMS user ).
const TText & password =TStandardText :: GetEmptyText () -The password associated with the user of a logon step. This will have different meanings according to the particular logon step (for example, host user password or DBMS user password ).
const TText & other1 =TStandardText :: GetEmptyText () -The first step-specific parameter.
const TText & other2 =TStandardText :: GetEmptyText () -The second step-specific parameter.
const TText & other3 =TStandardText :: GetEmptyText () -Third step-specific parameter.
const TText & other4 =TStandardText :: GetEmptyText () -The fourth step-specific parameter.
const TSQLLogonStep & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLLogonStep::~TSQLLogonStep

virtual ~ TSQLLogonStep ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLLogonStep::operator=

TSQLLogonStep & operator =(const TSQLLogonStep &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSQLLogonStep & -The logon step to be copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLLogonStep::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns a hash value for collections.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A hash value for collections.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLLogonStep::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLLogonStep::operator>>=

virtual TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLLogonStep::GetName

const TText & GetName (TText &) const

Interface Category:

API.

Purpose:

Returns the name of a logon step. The logon step name can be used to specify such things as database name, host name, and so on.

Calling Context:

Call this function directly.

Parameters:

TText & -On return, holds the logon step name.

Return Value:

A const reference to the name of a logon step.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLLogonStep::GetUser

const TText & GetUser (TText &) const

Interface Category:

API.

Purpose:

Returns the user name of a logon step. This will have different meanings according to the particular logon step (for example, host user or DBMS user ).

Calling Context:

Call this function directly.

Parameters:

TText & -On return, holds the user name.

Return Value:

A const reference to the user name of the logon step.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLLogonStep::GetPassword

const TText & GetPassword (TText &) const

Interface Category:

API.

Purpose:

Returns the password associated with the user of a logon step. This will have different meanings according to the particular logon step (for example, host user password or DBMS user password ).

Calling Context:

Call this function directly.

Parameters:

TText & -On return, holds the password.

Return Value:

A const reference to the password.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLLogonStep::GetOther

const TText & GetOther (TText &, OtherItem) const

Interface Category:

API.

Purpose:

Returns the value of the specified item associated with the user of a logon step. This will have different meanings according to the particular logon step.

Calling Context:

Call this function directly.

Parameters:

TText & -On return, holds the requested item.
OtherItem -Specifies the auxiliary parameter.

Return Value:

A const reference to the value of the specified item.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLLogonStep::SetName

virtual void SetName (const TText &)

Interface Category:

API.

Purpose:

Sets the name of a logon step.

Calling Context:

Call this function directly.

Parameters:

const TText & -The logon step name.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLLogonStep::SetUser

virtual void SetUser (const TText &)

Interface Category:

API.

Purpose:

Sets the user name of a logon step.

Calling Context:

Call this function directly.

Parameters:

const TText & -The user name.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLLogonStep::SetPassword

virtual void SetPassword (const TText &)

Interface Category:

API.

Purpose:

Sets the password associated with the user of a logon step.

Calling Context:

Call this function directly.

Parameters:

const TText & -The password.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLLogonStep::SetOther

virtual void SetOther (const TText &, OtherItem)

Interface Category:

API.

Purpose:

Sets the value of the specified item associated with the user of a logon step.

Calling Context:

Call this function directly.

Parameters:

const TText & -The new value of the item.
OtherItem -Specifies the additional logon step parameter.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLLogonStep::IsEqual

virtual bool IsEqual (const MCollectible *) const

Interface Category:

API.

Purpose:

Determines if this object equals its argument.

Calling Context:

Call this function directly.

Parameters:

const MCollectible * -The object to compare with this object.

Return Value:

Returns true if all members are equal.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.