EsbValidateHCtx

特定のコンテキスト・ハンドル(hCtx)を検証します。

構文

            EssValidateHCtx
             (
            hCtx
            )
         

備考

この関数を待機期間延長後に使用すると、プログラムのコンテキスト・ハンドルがサーバーによって認識される状態を確保できます。

戻り値

この関数はコンテキスト・ハンドルが有効な場合は0を戻し、それ以外の場合は無効なコンテキスト・ハンドルを示すエラー・コードを戻します。無効なコンテキスト・ハンドルに対して考えられる理由には、ログインがタイムアウトした、またはユーザーが管理者によって明示的にログアウトされたなどがあります。

アクセス

この関数には、特別なアクセス権は必要ありません。

例

                 Dim sts As Long
        Dim Count As Integer
        Dim pAccess As Integer  sts = EsbLogin(hInst, "localhost", "test", "testing", Count, hCtx)
        sts = EsbSetActive(hCtx, "sample", "Basic", pAccess)
        
        ' Do something else not related to Essbase Server
        
        sts = EsbValidateHCtx(hCtx)
        If (sts <> 0) Then
            'if Context no longer valid, re-login       
            sts = EsbLogin(hInst, "localhost", "test", "testing", Count, hCtx)
            sts = EsbSetActive(hCtx, "Sample", "Basic", pAccess)
        End If
        
        'Proceed
      

関連トピック

• EsbLogin
• EsbAutoLogin
• EsbTerm