ユーザーをEssbaseサーバーにログインさせます。この関数は通常、 EsbInitが正しく実行された後で、かつコンテキスト・ハンドルの引数を必要とするその他すべてのVB APIが呼び出される前に呼び出す必要があります。
構文
EsbLogin (
hInst, Server, User, Password, pItems, hCtx
)
ByVal
hInst
As Long
ByVal
Server
As String
ByVal
User
As String
ByVal
Password
As String
pItems
As Integer
hCtx
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 |
パスワード文字列。必須フィールド。 |
pItems |
アクセス可能なアプリケーションおよびデータベースのアイテムを受け取る変数のアドレス。 |
hCtx |
Essbaseサーバー・コンテキスト・ハンドルへのポインタ。 |
備考
Microsoft Windowsでプログラミングをする場合は、EsbLoginのかわりにEsbAutoLogin関数を使用することを検討する必要があります。
同じユーザー名とサーバーに対してEsbLoginを複数回呼び出すことができます。指定したサーバーに対してログインするたびに、APIから一意のコンテキスト・ハンドルが戻されます。
戻り値
成功の場合、Essbaseサーバー・コンテキスト・ハンドルがphCtxに戻され、他のAPI関数への後続の呼出しで引数として使用できます。また、指定したユーザーがアクセス可能なデータベースのアイテムがpItemsに戻され、EsbGetNextItemを呼び出して読み取ることができる、アクセス可能なアプリケーションおよびデータベースのリストが生成されます。
アクセス
この関数を呼び出す前に、EsbInit関数を呼び出して、最初にAPIを初期化し有効なインスタンス・ハンドルを取得する必要があります。
例
Declare Function EsbLogin Lib "ESBAPIN" (ByVal hInst As Long, ByVal Server As String, ByVal User As String, ByVal Password As String, Items As Integer, hCtx As Long) As Long
Sub ESB_Login ()
Dim hInst As Long
Dim Server As String * ESB_SVRNAMELEN
Dim User As String * ESB_USERNAMELEN
Dim Password As String * ESB_PASSWORDLEN
Dim Items As Integer
Dim AppDb As ESB_APPDB_T
Dim hCtx As Long '*****************
' Login to Essbase Server
'*****************
sts = EsbLogin (hInst, Server, User, Password, Items, hCtx) For n = 1 To Items '*******************************
' Get next Application/Database
' name combination from the list
'*******************************
sts = EsbGetNextItem (hCtx, ESB_LAPPDB_TYPE,AppDb)
Next
End Sub
関連トピック