GetAuthenticationAlgorithm

Description

Returns the AuthenticationAlgorithm of the schema repository.

Returns a valid AuthenticationAlgorithm unless an exception is thrown (for example, due to a communication failure with the schema repository). Calling this method does not require special privileges.

Note: This method became available in version 2003.06.14.

Syntax

VBScript


adminSession.GetAuthenticationAlgorithm()

Perl


$adminSession->GetAuthenticationAlgorithm();

Identifier: Description
adminSession: The AdminSession object representing the current schema repository access session.
Return value: Returns a Long containing the AuthenticationAlgorithm of the schema repository.

Examples

VBScript

' set the admin session ...
  set adminSession = CreateObject("ClearQuest.AdminSession")
  adminSession.Logon "admin", "admin", ""
' check preferred authentication algorithm:  
  Dim cquser2 ' a user object
  Dim authAlg ' the authentication algorithm value
  authAlg = adminSession.GetAuthenticationAlgorithm()
  StdOut "Authentication algorithm: " & CStr(authAlg) & vbCrLf

Perl

use CQPerlExt;
#Create a HCL Compass admin session
$adminSession = CQAdminSession::Build();
#Logon as admin
$adminSession->Logon( "admin", "admin", "" );
$adminSession->GetAuthenticationAlgorithm();
# ...
CQAdminSession::Unbuild($adminSession);