Distributed Tuning Interface のリファレンス : PvGetMkdeClientId()
 
このページをシェアする                  
PvGetMkdeClientId()
アクティブな MicroKernel エンジン クライアントのクライアント ID を取得します。
ヘッダー ファイル:monitor.h(ヘッダー ファイルも参照)
関数が最初に利用可能になるライブラリ:w3dbav75.dll(Windows)、libpsqldti.so(Linux)、libpsqldti.dylib(OS X)(リンク ライブラリも参照)
構文
BTI_SINT PvGetMkdeClientId(
   BTI_LONG           hConnection,
   BTI_ULONG          sequence,
   PVCLIENTID*        pClientId);
引数
 
In
hConnection
サーバーを識別する接続ハンドル。接続ハンドルは PvConnectServer()関数によって取得されます。
In
sequence
MicroKernel エンジン クライアントのシーケンス番号(0 基準)。PvGetMkdeClientsData()によって返される値を上限とした、有効な範囲内の番号でなければなりません。
Out
pClientId
返されたクライアント ID 情報を格納する PVCLIENTID 構造体のアドレス。
戻り値
 
P_OK
操作は成功しました。
P_E_INVALID_HANDLE
接続ハンドルが無効です。
P_E_DATA_UNAVAILABLE
アクティブなクライアントに関連するデータがありません。
P_E_NULL_PTR
ヌル ポインターによる呼び出しです。
P_E_INVALID_SEQUENCE
シーケンス番号が無効です。
P_E_FAIL
その他の理由により失敗しました。
備考
以下の前提条件を満たす必要があります。
PvStart()呼び出しによって DTI セッションが開始されている。
PvConnectServer()によって接続が確立している。ただし、ローカル マシンで操作を実行する場合は、接続ハンドルとして P_LOCAL_DB_CONNECTION を使用できます。
PvGetMkdeClientsData()呼び出しによって、アクティブなクライアントのデータが取得されている。
関連項目
PvStart()
PvConnectServer()
PvGetMkdeClientsData()
PvGetMkdeClientInfo()
PvFreeMkdeClientsData()
PvDisconnect()
PvStop()