iscEngineGetPref()

目的

iscEngineGetPref() は、現在のプリファレンス設定を取り出します。

構文 

isy_INT32 iscEngineGetPref(
    HISCENG              hEngine,
    isy_CONST isy_INT32  prefID,
    isy_TCHAR           *prefVal,
    isy_CONST isy_INT32  prefLen);

関数の引き数

表 148 は、iscEngineGetPref() 関数で使用される有効な引き数をリストしたものです。

表 148. iscEngineGetPref() の引き数

データ・タイプ 引き数 用途 説明
HISCENG hEngine 入力 同期エンジンへのハンドル
isy_CONST isy_INT32 prefID 入力 プリファレンス ID。以下のいずれかの値です。
  • ISCPREF_Timeout: メッセージ受信時のタイムアウトの長さ
  • ISCPREF_Trace: 詳細トレース
isy_TCHAR* prefVal 出力 戻されたプリファレンス値を保管するためのバッファーへのポインター。 事前定義されたプリファレンス定数もあります。

ISCPREF_Trace プリファレンスの場合は以下のとおりです。

  • ISCCONST_TraceON: 詳細デバッグ・トレースをオンにします。
  • ISCCONST_TraceOFF: 詳細デバッグ・トレースをオフにします。

ISCPREF_Timeout プリファレンスの場合は以下のとおりです。

  • ISCCONST_TimeoutNever: サーバー応答の待機中にタイムアウトになりません。
  • ISCCONST_TimeoutMinimum: タイムアウトの最短時間。
isy_CONST isy_INT32 prefLen 入力 提供されたバッファー (prefVal) のサイズ。

使用法

iscEngineGetPref() は、同期エンジンのプリファレンス設定 (デフォルト値または iscEngineSetPref() によって設定された値のいずれか) を取得するために使用します。

戻りコード

制約事項

提供されるバッファーは、各プリファレンス値を保管することのできる十分な大きさがなければなりません。

関連した概念

関連したタスク

関連した解説