Skip to main content

ModelCenter APIs 2026 R1 SP03

Interface ModelCenter::ILoginCallback

Last update: 30.07.2026

Definition: ModelCenter/src/ModelCenter.odl (line 4918)

The Login Callback allows non-ModelCenter processes to hook into ModelCenter's authentication. Primarily used when running ModelCenter in server mode.

Members

Public functions

Function requestAuthCredentials

boolean ModelCenter::ILoginCallback::requestAuthCredentials(BSTR uri, boolean isFailedAttempt, VARIANT *username, VARIANT *password, VARIANT *savePassword)

Called when ModelCenter needs to request a username and password. Parameters:

  • uri: URI authenticating to
  • isFailedAttempt: true if request is due to previous failed attempt, false otherwise
  • username: Username to use. Cannot be null.
  • password: Password to use. Cannot be null.
  • savePassword: True if password should be saved, false otherwise. Cannot be null.

Returns:

true if username/password is submitted, false otherwise

Exceptions:

  • COM: exception if username, password, or savePassword is null

Parameters:

  • BSTR uri
  • boolean isFailedAttempt
  • VARIANT * username
  • VARIANT * password
  • VARIANT * savePassword

Return type: boolean

Function loginSucceeded

void ModelCenter::ILoginCallback::loginSucceeded(BSTR uri, BSTR username, BSTR password, boolean savePassword)

Called when ModelCenter succeeds in authentication. Parameters:

  • uri: URI successfully authenticated to
  • username: username that successfully authenticated
  • password: password that successfully authenticated
  • savePassword: true if password should be saved, false otherwise

Parameters:

  • BSTR uri
  • BSTR username
  • BSTR password
  • boolean savePassword

Return type: void

Function verifySslWarning

boolean ModelCenter::ILoginCallback::verifySslWarning(BSTR msg)

Called when ModelCenter needs an SSL warning to be verified/accepted. Parameters:

  • msg: message to display to user

Returns:

true if ModelCenter should proceed, false otherwse

Parameters:

  • BSTR msg

Return type: boolean

Connect with Ansys