IBM Security Access Manager for Enterprise Single Sign-On, バージョン 8.2

ランタイム・オブジェクト

以下の各表に、AccessStudio ランタイム・オブジェクトのプラグイン API の仕様を示します。

runtime.GetPropertiesContainer()
説明 プロパティー項目とアカウント・データ・バッグを操作するために使用できる、プロパティー・コンテナー・オブジェクトを取得します。
詳細 プロパティー項目は変数と似ており、ストリング値を保管するために使用できます。 アカウント・データ・バッグも変数と似ており、状態マシンの実行時にユーザー資格情報を保管するために使用されます。
パラメーター  
戻り PropertyContainer オブジェクト
runtime.CreateObject([in]BSTR bstrObjId)
説明 指定された ProgID または CLSID を持つ COM オブジェクトを作成します。
注: この API では、自動化オブジェクトのインスタンス化のみを行うことができます。
詳細 このオブジェクトは、VBScript および JScript で使用可能な標準の CreateObject API と似ていますが、 クラスの CLSID を直接受け取ることもできる点が異なります。 この機能は、ProgID が定義されていないオブジェクトをインスタンス化するときに役立ちます。
パラメーター [IN] bstrObjId - インスタンス化するオブジェクトの ProgID または CLSID ストリング
戻り インスタンス化されたオブジェクトの自動化インターフェース
runtime.ShowMessageBox([in]BSTR bstrText, [in]BSTR bstrCaption)
説明 指定したテキストと表題を持つ、所有者ウィンドウのないメッセージ・ボックスを表示します。
注: VBScript の MsgBox および JScript の alert 関数は、プラグインでは機能しません。
詳細 この API は、所有者ウィンドウのない、「OK」ボタン付きの標準の Windows メッセージ・ボックスを表示します。メッセージ・ボックスは、モーダルにはなりません。つまり、ユーザーは、ポップアップが存在している間でも、 親アプリケーションと対話することができます。
パラメーター

[IN] bstrText - メッセージ・ボックスに表示されるメッセージ。

[IN] bstrCaption - メッセージ・ボックスのタイトル。

戻り なし
runtime.GetHTMLDocument()
説明 Web ページの状態マシンで使用される現在の HTML Document オブジェクトを取得します。
詳細 HTML 文書を使用して、Web ページ内の HTML 要素に対するアクセス/変更を行うことができます。
パラメーター  
戻り HTML 文書の自動化インターフェース
runtime.GetUserDataProvider()
説明 ユーザー・データ・プロバイダー・オブジェクトを取得します。
詳細 ユーザー・データ・プロバイダー・オブジェクトを使用すると、 ユーザー・ポリシーとシステム・ポリシーの取得、およびユーザー・ポリシーの設定を行うことができます。
パラメーター  
戻り UserDataProvider オブジェクト
runtime.Sleep([in]long lTimeMil)
説明 指定された時間、スレッドを待機させます。
詳細 呼び出し側のスレッドは、指定された時間だけスリープ状態になります。 この API の代わりに「一定時間待機」アクションを使用してください。これは、このアクションがそのトリガーの次のアクションの実行を単に遅延させるためです。
パラメーター [IN] lTimeMil - 待機時間 (ミリ秒)。
戻り なし
runtime.GetWindowController()
説明 ウィンドウ・コントローラーを取得します。
詳細 ウィンドウ・コントローラー・オブジェクトは、ウィンドウ・プロパティーを取得および設定するために使用されます。
パラメーター  
戻り ウィンドウ・コントローラー・オブジェクト
runtime.ShowModalMessageBox([in]long hParent, [in]BSTR bstrText, [in]BSTR bstrCaption)
説明 所有者として指定されたウィンドウを持つモーダル・メッセージ・ボックスを表示します。
注: VBScript の MsgBox および JScript の alert 関数は、プラグインでは機能しません。
詳細 この API は、「OK」ボタン付きの標準の Windows メッセージ・ボックスを表示します。親ウィンドウ・ハンドルが指定された場合、メッセージ・ボックスはモーダルになります。つまり、ユーザーは、このポップアップが閉じられるまで、親アプリケーションと対話することができません。親ウィンドウ・ハンドルが指定されていない場合、表示されるウィンドウは、ShowMessageBox 関数で表示されるウィンドウのように、モードレスになります。
パラメーター

[IN] hParent - 所有者ウィンドウ・ハンドル。このハンドルは、子ウィンドウにすることはできません。この値が 0 の場合、メッセージ・ボックスは所有者ウィンドウを持ちません。

[IN] bstrText - メッセージ・ボックスに表示されるメッセージ。

[IN] bstrCaption - メッセージ・ボックスのタイトル。

戻り なし
runtime.GetHTMLElementsFromXPath([in]IDispatch* pDoc, [in]BSTR bstrXPath)
説明 HTML 文書オブジェクトに対して指定されたシグニチャーを評価して、 一致した HTML 要素の配列を戻します。
注: HTML 文書オブジェクトは、このオブジェクトの GetHTMLDocument API を呼び出すことにより取得できます。
詳細  
パラメーター

[IN] pDoc - HTML Document2 オブジェクト

[IN] bstrXPath - 評価用に使用されるシグニチャー・ストリング。

戻り 指定されたシグニチャーに一致した HTML 要素の配列
runtime.ReAuthPassCode([in, optional]long hParent)
説明 ユーザーにパスワードの入力を求める再認証画面がポップアップ表示されます。
詳細  
パラメーター [IN, OPTIONAL] hParent - 再認証ポップアップの所有者ウィンドウとして使用するウィンドウ。 この値を指定しない場合、またはこの値が 0 の場合、ポップアップは所有者ウィンドウを持ちません。
戻り 正常に再認証された場合は VARIANT_FALSE (-1)

再認証に失敗した場合は VARIANT_TRUE (0)

runtime.GetBrowserObjectFromHTMLDocument([in]IDispatch* pDoc)
説明 特定の HTML 文書オブジェクトの WebBrowser オブジェクトを取得します。
注: HTML 文書は、GetHTMLDocument API を使用することにより取得できます。
詳細 Web ブラウザー・オブジェクトは、指定された HTML 文書を含むブラウザー・ウィンドウを制御する機能を提供します。
パラメーター [IN] pDoc - HTML Document オブジェクト
戻り IWebBrowser2 インターフェースを実装する WebBrowser オブジェクト
runtime.GetAccessProfileId()
説明 現在の AccessProfile の ID を取得します。
詳細  
パラメーター  
戻り AccessProfile ID ストリング
SetTextOutMonitoringState([in] VARIANT_BOOL bEnabled)
説明 プロファイルでメインフレーム・サポートが有効になっているという前提の下で、アプリケーションのテキスト・モニタリングを使用不可または使用可能にします。
詳細 この操作は、テキスト出力モニタリングによってアプリケーションのパフォーマンスや動作に副次作用がある稀な場合に行います。 この場合は、SSO の実行後にテキスト・モニタリングを使用不可にします (画面のテキスト出力のモニターが以後不要な場合)。
パラメーター [IN] bEnabled - 使用可能にする場合は 1、 使用不可にする場合は 0
戻り なし
GetTextOutMonitoringState([out,retval] VARIANT_BOOL *pbEnabled)
説明 アプリケーションの画面のテキスト・モニタリングが使用可能であるかどうかを確認します。
詳細  
パラメーター  
戻り 使用可能の場合は 1

使用不可の場合は 0

GetObsScriptDebugObject([out,retval] IObsScriptDbgSupport** pRet
説明 デバッグ目的でログ・メッセージを書き込むために使用される ObsScriptDebug オブジェクトを取得します。
詳細  
パラメーター  
戻り  


フィードバック