EssAutoLogin

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

構文

            ESS_FUNC_M EssAutoLogin 
            (hInstance, Server, UserName,
Password, AppName, DbName, Options, pAccess, phCtx)
            ;

パラメータ	データ型	説明
hInstance	ESS_HINST_T	APIインスタンス・ハンドル
Server	ESS_SVRNAME_T	ネットワーク・サーバー名文字列サーバー名は、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
UserName	ESS_USERNAME_T	ユーザー名文字列
Password	ESS_PASSWORD_T	パスワード文字列
AppName	ESS_ APPNAME _T	アプリケーション名
DbName	ESS_ DBNAME _T	データベース名
Options	ESS_USHORT_T	オプションのフラグ。値: AUTO_NODIALOG - (前述の引数の)デフォルト設定を使用して、ダイアログを表示しないでユーザーのログインを試みます。 AUTO_NOSELECT - ユーザーは、アプリケーションおよびデータベースを選択しないでもログインできます(ダイアログの下側の部分が表示されません)。 OR演算子(\|)を使用してAUTO_NODIALOGとAUTO_NOSELECTの両方を設定し、ダイアログ・ボックスの表示およびアプリケーションとデータベースの選択を省略して、ユーザー・ログインを実行します。 AUTO_NODIALOG\|AUTO_NOSELECT: AUTO_DEFAULT - ダイアログ・ボックスが表示され、ユーザーは対話形式でログインし、アプリケーションとデータベースを選択できます。
pAccess	ESS_PACCESS_T	データベース・アクセス・レベルを受け取る変数のアドレス。
phCtx	ESS_PHCTX_T	Essbaseコンテキスト・ハンドルを受け取る変数のアドレス。再ログインする既存の(有効な)コンテキスト・ハンドルを再使用する場合を除いて、ESS_INVALID_HCTXに設定します。

備考

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

戻り値

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

アクセス

この関数を呼び出す前に、EssInit関数を呼び出し、APIを初期化して、有効なインスタンス・ハンドルを取得してください。