Distributed Tuning Interface Guide (v11)

PvGetSettingHelp() (DTI 関数)

設定に関連するヘルプ文字列を取得します。

ヘッダー ファイル:config.h(ヘッダー ファイルも参照)

関数が最初に利用可能になるライブラリ:w3dbav75.dll(Windows)、libpsqldti.so(Linux)(リンク ライブラリも参照)

構文

BTI_SINT PvGetSettingHelp( 
	BTI_ULONG         settingID, 
	BTI_ULONG_PTR      pBufSize, 
	BTI_CHAR_PTR       pHelpString); 

引数

In
settingID
設定の一意な識別子。設定の一覧は、PvGetSettingList() (DTI 関数)から取得できます。
In/Out
pBufSize
設定値を受け取るために割り当てられたバッファーのサイズを格納する、符号なし Long 型のアドレス。設定値の実際のサイズを受け取ります。サイズにはヌル終端文字を含める必要があります。
Out
pHelpString
返された文字列値。

戻り値

P_OK
操作は成功しました。
P_E_NULL_PTR
ヌル ポインターによる呼び出しです。
P_E_BUFFER_TOO_SMALL
割り当てられたバッファーが小さすぎるので、表示文字列は切り詰められます。この場合、必要なバッファー サイズが pBufSize に返されます。
P_E_FAIL
その他の理由により失敗しました。

備考

以下の前提条件を満たす必要があります。

関連項目

PvStart() (DTI 関数)
PvConnectServer() (DTI 関数)
PvGetCategoryList() (DTI 関数)
PvGetSettingList() (DTI 関数)
PvGetSettingInfo() (DTI 関数)
PvDisconnect() (DTI 関数)
PvStop() (DTI 関数)


PvGetServerName() (DTI 関数)

PvGetSettingHelpSize() (DTI 関数)