PvGetSettingList()
指定されたカテゴリに属する設定の一覧を取得します。
ヘッダー ファイル：config.h（
ヘッダー ファイルも参照）
関数が最初に利用可能になるライブラリ：w3dbav75.dll（Windows）、libpsqldti.so（Linux）、libpsqldti.dylib（OS X）（
リンク ライブラリも参照）
構文
BTI_SINT PvGetSettingList(
BTI_LONG hConnection,
BTI_ULONG categoryID,
BTI_ULONG_PTR pNumSettings,
BTI_ULONG_PTR pSettingList);
引数
In | hConnection | サーバーを識別する接続ハンドル。接続ハンドルは PvConnectServer() 関数によって取得されます。 |
In | categoryID | カテゴリの一意な識別子。 |
Out | pNumSettings | 入力時は配列のサイズを格納し、戻り時は返された一覧の項目数を受け取る、符号なし Long 型のアドレス。 |
Out | pSettingList | 返される設定 ID の一覧へのポインター。 |
戻り値
P_OK | 操作は成功しました。 |
P_E_INVALID_HANDLE | 接続ハンドルが無効です。 |
P_E_NULL_PTR | ヌル ポインターによる呼び出しです。 |
P_E_BUFFER_TOO_SMALL | 配列のサイズが小さすぎます。この場合、必要なサイズが pNumSettings に返されます。 |
P_E_FAIL | その他の理由により失敗しました。 |
備考
接続がリモート接続の場合、カテゴリのサーバー側の設定のみが返されます。接続がローカル接続の場合、このカテゴリのクライアント側とサーバー側両方の設定が返されます。
設定項目に対する設定が現時点で可能であるかどうかを判断するには、
PvIsSettingAvailable() を使用します。
以下の前提条件を満たす必要があります。
•PvConnectServer() によって接続が確立している。ただし、ローカル マシンで操作を実行する場合は、接続ハンドルとして P_LOCAL_DB_CONNECTION を使用できます。
関連項目