iscEngineSetPref()

目的

iscEngineSetPref() は、同期エンジンのプリファレンスを設定します。

構文 

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

関数の引き数

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

表 147. iscEngineSetPref() の引き数

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

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

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

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

  • ISCCONST_TimeoutNever: サーバー応答の待機中にタイムアウトになりません。
  • ISCCONST_TimeoutMinimum: タイムアウトの最短時間。

使用法

iscEngineSetPref() は、同期エンジンのプリファレンスを設定するために使用します。 これらのプリファレンスは永続的なものではなく、同期エンジンへの新規ハンドルをオープンするたびにリセットしなければなりません。

戻りコード

制約事項

指定されたプリファレンス値は、所定のプリファレンス制限内に収まらなければなりません。

関連した概念

関連したタスク

関連した解説