Distributed Tuning Interface のリファレンス : PvGetMkdeClientHandlesData()
 
このページをシェアする                  
PvGetMkdeClientHandlesData()
アクティブなクライアントに関連する MicroKernel エンジン クライアント ハンドルの数を取得します。
ヘッダー ファイル:monitor.h(ヘッダー ファイルも参照)
関数が最初に利用可能になるライブラリ:w3dbav75.dll(Windows)、libpsqldti.so(Linux)、libpsqldti.dylib(OS X)(リンク ライブラリも参照)
構文
BTI_SINT PvGetMkdeClientHandlesData(
   BTI_LONG           hConnection,
   PVCLIENTID*        pClientId,
   BTI_ULONG_PTR      pCount);
引数
 
In
hConnection
サーバーを識別する接続ハンドル。接続ハンドルは PvConnectServer()関数によって取得されます。
In
pClientId
MicroKernel エンジン クライアントを識別する PVCLIENTID 構造体のアドレス。
Out
pCount
MicroKernel エンジン クライアントのハンドル数を受け取る、符号なし Long 型のアドレス。
戻り値
 
P_OK
操作は成功しました。
P_E_INVALID_HANDLE
接続ハンドルが無効です。
P_E_DATA_UNAVAILABLE
MicroKernel エンジン クライアントに関連するデータがありません。
P_E_NULL_PTR
ヌル ポインターによる呼び出しです。
P_E_FAIL
その他の理由により失敗しました。
備考
この関数を呼び出すと、MicroKernel エンジン クライアント ハンドルに関するすべての情報が、それ以降のクライアント ハンドル関連の関数呼び出しのために、DTI によってキャッシュされます。クライアントに関するその他の情報については、PvGetMkdeClientsData()を参照してください。
この関数は、クライアント ハンドルの情報を返すほかの関数よりも先に呼び出される必要があります。
PvFreeMkdeClientsData()を呼び出すと、MicroKernel エンジン クライアント ハンドル用にキャッシュされた情報がクライアントに関する情報と一緒に解放されます。
以下の前提条件を満たす必要があります。
PvConnectServer()によって接続が確立している。ただし、ローカル マシンで操作を実行する場合は、接続ハンドルとして P_LOCAL_DB_CONNECTION を使用できます。
PvGetMkdeClientsData()呼び出しによって、アクティブなクライアントのデータが取得されている。
呼び出し元には既に、アクティブな MicroKernel エンジン クライアントの有効なクライアント ID がある。
関連項目
PvStart()
PvConnectServer()
PvGetMkdeClientsData()
PvFreeMkdeClientsData()
PvDisconnect()
PvStop()