EsbAutoLogin

ユーザーがEssbaseサーバーにログインするためのダイアログ・ボックスを表示します。オプションでアクティブなアプリケーションとデータベースを選択できます。

構文

            EsbAutoLogin (
            hInst, Server, User, Password, AppName, DbName, opt, pAccess, phCtx
            )
ByVal 
            hInst
                As Long
ByVal 
            Server
               As String
ByVal 
            User
                 As String
ByVal 
            Password
             As String
ByVal 
            AppName
              As String
ByVal 
            DbName
               As String
ByVal 
            opt
                  As Integer
      
            pAccess
              As Integer
      
            phCtx
                As Long

パラメータ	説明
hInst	VB APIインスタンス・ハンドル。
Server	ネットワーク・サーバー名の文字列。サーバー名は、hostname、hostname:port、またはAPSサーブレットのエンドポイントにEssbaseフェイルオーバー・クラスタ名を付加したURLとして表すことができます。次に例を示します: http://myhost:13080/aps/Essbase?clustername=Essbase-Cluster1 保護モード(SSL)の場合、URLの構文は次のとおりです http[s]://host:port/aps/Essbase?ClusterName=logicalName&SecureMODE=yesORno たとえば、 https://myhost:13080/aps/Essbase?clustername=Essbase-Cluster1&SecureMODE=Yes
User	ユーザー名の文字列。
Password	パスワード文字列。
AppName	アプリケーション名。
DbName	データベース名。
Options	オプションのフラグ。値: ESB_AUTO_NODIALOG - (前述の引数の)デフォルト設定を使用して、ダイアログを表示しないでユーザーのログインを試みます。 ESB_AUTO_NOSELECT - ユーザーは、アプリケーションおよびデータベースを選択しないでもログインできます(ダイアログの下側の部分が表示されません)。 ESB_AUTO_NODIALOGとESB_AUTO_NOSELECTの両方を指定すれば、ダイアログ・ボックスは表示されず、ユーザーはアプリケーションとデータベースを選択しなくてもログインできます: ESB_AUTO_NODIALOG + ESB_AUTO_NOSELECT ESB_AUTO_DEFAULT - ダイアログ・ボックスが表示され、ユーザーは対話形式でログインし、アプリケーションとデータベースを選択できます。
pAccess	データベース・アクセス・レベルを受け取る変数のアドレス。
phCtx	Essbaseコンテキスト・ハンドルを受け取る変数のアドレス。

備考

この関数によって戻されるダイアログ・ボックスは自動的に関数によって管理され、ログイン・ダイアログでのユーザー・パスワードの変更やデータベース・ノート・メッセージの表示などの機能を提供します。これにより、VB APIを使用したすべてのアプリケーションで、標準化された、強力なログイン画面が使用できます。
Windows環境でプログラミングする場合は、この関数をEsbLogin関数のかわりに使用します。
この関数は、EsbInitが正しく実行された後で、かつコンテキスト・ハンドル引数を必要とするその他すべてのVB APIが呼び出される前に呼び出す必要があります。
この関数はWindows環境でのみサポートされます。UNIX環境ではサポートされません。
文字列引数Server、User、Password、AppNameまたはDbNameが含まれている必要があります。それらはオプションで空の文字列でもかまいません。いずれかが空の文字列でない場合、それらがポイントするバッファが、関数から戻される際に、ダイアログ・ボックスからユーザーによって選択された実績値で更新されます。渡された引数のいくつかが有効な文字列をポイントする場合、それらは、デフォルトでダイアログに表示される値として使用されます。これらの引数のバッファは、渡された値のみでなく、戻り値も含むことができる大きさである必要があります。
ログインに成功すると、サーバー名とユーザー名が(ファイルESSBASE.INIに)自動的に保管され、次にこの関数が呼び出される際にデフォルトとして使用されます(この引数が後続の呼出しに指定されていない場合)。正常に接続したすべてのサーバー名も保管され、表示されます。
「自動ログイン」ダイアログ・ボックスは、現在のアクティブなウィンドウ(フォーカスがあるウィンドウ)の子ウィンドウです。したがって、「自動ログイン」ダイアログが表示されている間は、アクティブなウィンドウを破棄したり、フォーカスを変更しないでください。
ユーザーがダイアログ・ボックスで取消しボタンまたは[Esc]キーを押した場合、この関数はESB_STS_CANCELの値を戻します。
Windows環境では、エンド・ユーザーが「ヘルプ」ボタンをクリックすると、Essbaseシステムのログインに関するヘルプ・トピックが開きます。ESB_INIT_T構造体の異なるヘルプ・ファイル名を指定すると、異なるヘルプ・ファイルをポイントするように「ヘルプ」ボタンを変更できます。

戻り値

正常終了の場合、phCtxのEssbaseコンテキスト・ハンドルを戻します。それを、他のVB API関数への後の呼出しで、引数として渡せます。また、pAccessで選択されたアプリケーションおよびデータベース(選択されている場合)へのユーザーのアクセス・レベルを戻します。

アクセス

この関数を呼び出す前に、EsbInit関数を呼び出して、最初にVB APIを初期化し有効なインスタンス・ハンドルを取得する必要があります。

例

         Declare Function EsbAutoLogin Lib "ESBAPIN" (ByVal hInst As Long, ByVal Server As String, _
                                             ByVal User As String, ByVal Password As String, _
                                             ByVal AppName As String, ByVal DbName As String, _
                                             ByVal Opt As Integer, pAccess As Integer, _
                                             phCtx As Long) As Long
Sub ESB_AutoLogin ()
   Dim sts As Long
   Dim Server As String * ESB_SVRNAMELEN
   Dim User As String * ESB_USERNAMELEN
   Dim Password As String * ESB_PASSWORDLEN
   Dim AppName As String * ESB_APPNAMELEN
   Dim DbName As String * ESB_DBNAMELEN
   Dim pOption As Integer
   Dim pAccess As Integer
   Dim hCtx As Long 
   '**********************
   ' Initialize parameters
   '********************** 
   Server = "Server"
   User = "User"
   Password = "Password"
   AppName = ""
   DbName = ""
   pOption = ESB_AUTO_DEFAULT 
   '************************
   ' Login to Essbase Server
   '************************ 
   sts = EsbAutoLogin (hInst, Server, User, Password, AppName, DbName, pOption, pAccess, hCtx)
End Sub