{{div_begin}}
[[←　6 章に戻る|C/C++ Sync Suite Reference601/6]]　[[↑トップへ|C/C++ Sync Suite Reference601]]　[[8 章に進む　→|C/C++ Sync Suite Reference601/8]]
{{div_end}}

{{div_begin style="margin-bottom:-10px"}}
!!!7 HotSync ログ API
{{div_end}}

{{div_begin "style='position:absolute;right:0px;font-size:70%;margin-right:15px;margin-top:15px;width:250px;'"}}
*{{goto HotSync Log Constants,HotSync ログ定数}}
**{{goto Activity,Activity}}
*{{goto HotSync Log Functions,HotSync ログ関数}}
**{{goto LogAddEntry,LogAddEntry}}
**{{goto LogAddFormattedEntry,LogAddFormattedEntry}}
**{{goto LogTestCounters,LogTestCounters}}
*{{goto HotSync Log API Error Codes,HotSync ログ API エラー コード}}
{{div_end}}

{{div_begin "style='position:relative;padding:0px;padding-right:5px;padding-left:10px;margin-right:250px;margin-top:20px;width:auto;border-right-style:dotted;border-right-width:2px;border-right-color:silver;'"}}
HotSync ログ API はコンジットがメッセージをキューに追加することを可能にします。キューに追加されたメッセージは後で HotSync ログに書き込まれます。メッセージは同期プロセスが終了するまでに HotSync ログに書き込まれます。

HotSync ログ関数は {{span style='color:blue;font-family:monospace;',HSLog20.dll}} の中で利用可能であり、{{span style='color:blue;font-family:monospace;',HSLog.h}} の中で宣言されています。

この章は以下の節に分かれています:

*{{goto HotSync Log Constants,HotSync ログ定数}}
*{{goto HotSync Log Functions,HotSync ログ関数}}
*{{goto HotSync Log API Error Codes,HotSync ログ API エラー コード}}

HotSync ログについての更なる情報は、''Introduction to Conduit Development'' の {{goto Addin Messages to the HotSync Log,「HotSync ログへのメッセージの追加」|Introduction to Conduit Development601/4}} を参照してください。


!!{{anchor HotSync Log Constants}}HotSync ログ定数 {{goto top,^TOP^}}

この節では、あなたが HotSync ログ関数で使用することができる列挙定数 {{goto Activity,Activity}} について説明します。


!{{anchor Activity}}Activity 列挙体 {{goto top,^TOP^}}

'''目的'''

コンジットに {{span style='color:blue;font-family:monospace;',LogAddEntry()}} または {{span style='color:blue;font-family:monospace;',LogAddFormattedEntry()}} を呼び出させてエントリをログに追加させるアクティビティを指定します。

'''宣言されている場所'''

{{span style='color:blue;font-family:monospace;',HSLog.h}}

'''定数'''

*{{span style='color:blue;font-family:monospace;',slText = -1 }}
**コンジットにワーニング カウンタを増加させることなしにテキストをログに追加することを許可します。
*{{span style='color:blue;font-family:monospace;',slDoubleModify }}
**レコードがデスクトップ コンピュータ上とハンドヘルド上の両方で変更されました。
*{{span style='color:blue;font-family:monospace;',slDoubleModifyArchive }}
**デスクトップ上とハンドヘルド上の両方で変更されたレコードはアーカイブされました。
*{{span style='color:blue;font-family:monospace;',slReverseDelete }}
**片方で削除されたレコードは同じレコードが他方で変更されたためにレストアされました。
*{{span style='color:blue;font-family:monospace;',slTooManyCategories }}
**これ以上カテゴリを追加することはできません。
*{{span style='color:blue;font-family:monospace;',slCategoryDeleted }}
**カテゴリが削除されました。
*{{span style='color:blue;font-family:monospace;',slDateChanged }}
**日付が変更されました。
*{{span style='color:blue;font-family:monospace;',slCustomLabel }}
**カスタム ラベルが変更されました。
*{{span style='color:blue;font-family:monospace;',slChangeCatFailed }}
**カテゴリの変更に失敗しました。
*{{span style='color:blue;font-family:monospace;',slRemoteReadFailed }}
**ハンドヘルド上でのレコードの読み込みに失敗しました。
*{{span style='color:blue;font-family:monospace;',slRemoteAddFailed }}
**ハンドヘルドへのレコードの追加に失敗しました。
*{{span style='color:blue;font-family:monospace;',slRemotePurgeFailed }}
**ハンドヘルド上でのレコードの削除 (purge, 複数のレコードを削除すること) に失敗しました。
*{{span style='color:blue;font-family:monospace;',slRemoteChangeFailed }}
**ハンドヘルド上でのレコードの変更に失敗しました。
*{{span style='color:blue;font-family:monospace;',slRemoteDeleteFailed }}
**ハンドヘルド上でのレコードの削除 (delete, 1 個のレコードを削除すること) に失敗しました。
*{{span style='color:blue;font-family:monospace;',slLocalAddFailed }}
**デスクトップ コンピュータへのレコードの追加に失敗しました。
*{{span style='color:blue;font-family:monospace;',slRecCountMismatch }}
**レコード カウントが一致しませんでした。
*{{span style='color:blue;font-family:monospace;',slXMapFailed }}
**ポジションの相互マッピング操作に失敗しました。
*{{span style='color:blue;font-family:monospace;',slArchiveFailed }}
**アーカイブ操作に失敗しました。
*{{span style='color:blue;font-family:monospace;',slLocalSaveFailed }}
**デスクトップ コンピュータへのデータ保存に失敗しました。
*{{span style='color:blue;font-family:monospace;',slResetFlagsFailed }}
**同期フラグのリセットに失敗しました。
*{{span style='color:blue;font-family:monospace;',slSyncStarted }}
**コンジットが同期操作を開始しました。
*{{span style='color:blue;font-family:monospace;',slSyncFinished }}
**コンジットが同期操作を成功裏に完了しました。
*{{span style='color:blue;font-family:monospace;',slSyncAborted }}
**同期操作は中断されました。
*{{span style='color:blue;font-family:monospace;',slWarning }}
**この定数はコンジットに提供された他のアクティビティのいずれかと適合しないというワーニングを記録させます。
*{{span style='color:blue;font-family:monospace;',slDoubleModifySubsc }}
**ファイル リンク レコードがデスクトップ上で変更されました。この値はファイル リンク Feature が HotSync マネージャ 6.0.1 以降で削除されたために使用を推奨されなくなりました。
*{{span style='color:blue;font-family:monospace;',slFileLinkCompleted }}
**ファイル リンクの処理が完了しました。この値はファイル リンク Feature が HotSync マネージャ 6.0.1 以降で削除されたために使用を推奨されなくなりました。
*{{span style='color:blue;font-family:monospace;',slFileLinkDeleted }}
**ファイル リンクが削除されました。この値はファイル リンク Feature が HotSync マネージャ 6.0.1 以降で削除されたために使用を推奨されなくなりました。
*{{span style='color:blue;font-family:monospace;',slSyncDidNothing }}
**ユーザはそのコンジットは同期の最中にいかなる操作も実行すべきではないと指示しました。あなたはこの値を HotSync マネージャ 6.0.1 以降でのみ使用することができます。
*{{span style='color:blue;font-family:monospace;',slSyncSessionStart }}
HotSync 操作が開始しました。HotSync マネージャ 6.0.1 以降のみがこの値を使用できます; コンジットは使用できません。
*{{span style='color:blue;font-family:monospace;',slSyncSessionEnd }}
**HotSync 操作が完了しました。HotSync マネージャ 6.0.1 以降のみがこの値を使用できます; コンジットは使用できません。
*{{span style='color:blue;font-family:monospace;',slSyncSessionCancelled }}
**ユーザは '''HotSync Progress''' ダイアログ ボックス上の '''Cancel''' をクリックしました。HotSync マネージャ 6.0.1 以降のみがこの値を使用できます; コンジットは使用できません。
*{{span style='color:blue;font-family:monospace;',slError }}
**エラーが起こりました。あなたはこの値を HotSync マネージャ 6.0.1 以降でのみ使用することができます。
*{{span style='color:blue;font-family:monospace;',slRecommendation }}
**ユーザに何かすることを推奨します - 例えば、コンジットの衝突を解決すること。あなたはこの値を HotSync マネージャ 6.0.1 以降でのみ使用することができます。
*{{span style='color:blue;font-family:monospace;',slHTMLText }}
**このタイプのログ エントリは HTML タグまたは文字を含みます。この値を使用すると文字列は変更されずにログに渡され、それにより HTML フォーマットとなります。他のすべての {{span style='color:blue;font-family:monospace;',Activity}} 値は HotSync ログ API に HTML 制御文字 (<, >, &) を HTML 等価文字 (&lt;, &gt;, &amp;) に置き換えさせます。あなたはこの値を HotSync マネージャ 6.0.1 以降でのみ使用することができます。

'''コメント'''

あなたのコンジットはどんなタイプのエントリをログに追加するのかを示すためにこれらの値を {{goto LogAddEntry,LogAddEntry()}} または {{goto LogAddFormattedEntry,LogAddFormattedEntry()}} に渡します。

更なる情報は、''Introduction to Conduit Development'' の {{goto Adding Messages to the HotSync Log,「HotSync ログへのメッセージの追加」|Introduction to Conduit Development601/4}} を参照してください。

'''互換性'''

*HotSync マネージャ バージョン: 上で説明された例外を除いて、すべて
*Palm OS バージョン: すべて

'''参照'''

{{goto LogAddEntry,LogAddEntry()}}, {{goto LogAddFormattedEntry,LogAddFormattedEntry()}}


!!{{anchor HotSync Log Functions}}HotSync ログ関数 {{goto top,^TOP^}}


この節では、あなたが HotSync ログへ書き込みすることを可能にする以下の関数について説明します。

,関数,説明
,"{{goto LogAddEntry,LogAddEntry()}}",メッセージをデスクトップ上の HotSync ログに追加します。
,"{{goto LogAddFormattedEntry,LogAddFormattedEntry()}}",フォーマットされたメッセージをデスクトップ上の HotSync ログに追加します。
,"{{goto LogTestCounters,LogTestCounters()}}",デスクトップ上の HotSync ログに追加されたメッセージの数を決定します。


!{{anchor LogAddEntry}}LogAddEntry 関数 {{goto top,^TOP^}}

'''目的'''

メッセージをデスクトップ上の HotSync ログに追加します。

'''宣言されている場所'''

{{span style='color:blue;font-family:monospace;',HSLog.h}}

'''Prototype'''

 long LogAddEntry (
    LPCTSTR pszEntry,
    Activity act,
    BOOL bTimeStamp
 )

'''パラメータ'''

*{{span style='color:blue;font-family:monospace;',→ pszEntry}}
**ログに追加する文字列。
*{{span style='color:blue;font-family:monospace;',→ act}}
**コンジットにエントリをログに追加させるアクティビティ。これは {{goto Activity,Activity}} 列挙値のうちの 1 つです。
*{{span style='color:blue;font-family:monospace;',→ bTimeStamp}}
**{{span style='color:blue;font-family:monospace;',true}} の場合、HotSync マネージャはタイム スタンプをログ エントリに付加します。

'''返り値'''

成功した場合、{{span style='color:blue;font-family:monospace;',slNoError}} を返します。

成功しなかった場合、-1 を返します。

'''コメント'''

HotSync ログについての更なる情報は、''Introduction to Conduit Development'' の {{goto Adding Messages to the HotSync Log,「HotSync ログへのメッセージの追加」|Introduction to Conduit Development601/4}} を参照してください。

'''互換性'''
*HotSync マネージャ バージョン: すべて
*Palm OS バージョン: すべて

'''参照'''

{{goto LogAddFormattedEntry,LogAddFormattedEntry()}}, {{goto Activity,Activity}}


!{{anchor LogAddFormattedEntry}}LogAddFormattedEntry 関数 {{goto top,^TOP^}}

'''目的'''

フォーマットされたメッセージをデスクトップ上の HotSync ログに追加します。

'''宣言されている場所'''

{{span style='color:blue;font-family:monospace;',HSLog.h}}

'''Prototype'''

 long LogAddFormattedEntry (
    Activity act,
    BOOL bTimeStamp,
    const char *dataString,
    ...
 )

'''パラメータ'''

*{{span style='color:blue;font-family:monospace;',→ act}}
**コンジットにエントリをログに追加させるアクティビティ。これは {{goto Activity,A*{{span style='color:blue;font-family:monospace;',→ bTimeStamp}}
**{{span style='color:blue;font-family:monospace;',true}} の場合、HotSync マネージャはタイム スタンプをログ エントリに付加します。
*{{span style='color:blue;font-family:monospace;',→ dataString}}
**フォーマットを指定する文字列。この文字列は標準 C ライブラリの {{span style='color:blue;font-family:monospace;',sprintf()}} などにフォーマット指定として渡される文字列と同じものです。
*{{span style='color:blue;font-family:monospace;',→ ...}}
**{{span style='color:blue;font-family:monospace;',dataString}} パラメータの中のフォーマット指定に対するパラメータ値。

成功した場合、{{span style='color:blue;font-family:monospace;',slNoError}} を返します。

成功しなかった場合、-1 を返します。

'''コメント'''

HotSync ログについての更なる情報は、''Introduction to Conduit Development'' の {{goto Adding Messages to the HotSync Log,「HotSync ログへのメッセージの追加」|Introduction to Conduit Development601/4}} を参照してください。

::重要
:::{{span style='color:blue;font-family:monospace;',dataString}} は 256 文字以内の文字列を指していなければなりません。それより長い文字列は HotSync マネージャをクラッシュさせる可能性があります。あなたが 256 文字を超えるフォーマット文字列をログに追加しなければならない場合、あなたはあなた自身のバッファで {{span style='color:blue;font-family:monospace;',sprintf()}} を使用して、あなたのバッファをログに書き込むために {{span style='color:blue;font-family:monospace;',LogAddEntry()}} を呼び出すことができます。

'''互換性'''

*HotSync マネージャ バージョン: すべて
*Palm OS バージョン: すべて

'''参照'''

{{goto LogAddEntry,LogAddEntry()}}, {{goto Activity,Activity}}


!{{anchor LogTestCounters}}LogTestCounters 関数 {{goto top,^TOP^}}

'''目的'''

デスクトップ上の HotSync ログに追加されたメッセージの数を決定します。

'''宣言されている場所'''

{{span style='color:blue;font-family:monospace;',HSLog.h}}

'''Prototype'''

 WORD LogTestCounters ()

'''パラメータ'''

ありません。

'''返り値'''

ログの中にあるメッセージの数を返します。ログがメッセージを持っていない場合は 0 を返します。

'''コメント'''

{{span style='color:blue;font-family:monospace;',LogTestCounters()}} 関数は以下のアクティビティ タイプのログ エントリをカウントしません:

*{{span style='color:blue;font-family:monospace;',slSyncAborted}}
*{{span style='color:blue;font-family:monospace;',slSyncFinished}}
*{{span style='color:blue;font-family:monospace;',slSyncStarted}}
*{{span style='color:blue;font-family:monospace;',slText}}

'''互換性'''

*HotSync マネージャ バージョン: 上で説明された例外を除いて、すべて
*Palm OS バージョン: すべて


!!{{anchor HotSync Log API Error Codes}}HotSync ログ API エラー コード {{goto top,^TOP^}}

{{goto Table 7.1,表 7.1}} はいくつかの HotSync ログ API 関数が返す可能性のあるエラー コードの値をリスト アップしています。各関数の説明ではその関数が返す可能性のあるエラーはどれなのかを述べています。値 -1 と {{span style='color:blue;font-family:monospace;',slNoError}} だけはこの API のパブリック関数のいずれかによって返されるということに注意してください。他の値はプライベート関数によってのみ使用されます。

以下の名前を付けられているエラー コードはすべて {{span style='color:blue;font-family:monospace;',LogError}} 列挙体の値として定義されています。{{span style='color:blue;font-family:monospace;',LogError}} 列挙体はヘッダ ファイル {{span style='color:blue;font-family:monospace;',HSLog.h}} の中で宣言されています。

{{anchor Table 7.1}}
'''表 7.1 HotSync ログ API エラー コード'''

,値,コード,説明
,-1,-,関数は成功しませんでした。
,0,"{{span style='color:blue;font-family:monospace;',slNoError}}",エラー無し。
,1,"{{span style='color:blue;font-family:monospace;',slBadStream}}",このストリームは無効です。
,2,"{{span style='color:blue;font-family:monospace;',slDeleteFileFailed}}",古いログ ファイルを削除できませんでした。
,3,"{{span style='color:blue;font-family:monospace;',slMoveFileFailed }}",使用中のログ ファイルを指定された位置に移動させることができませんでした。

{{div_end}}

{{div_begin "style='border-top-style:solid;border-top-width:1px;border-top-color:silver;'"}}
[[←　6 章に戻る|C/C++ Sync Suite Reference601/6]]　[[↑トップへ|C/C++ Sync Suite Reference601]]　[[8 章に進む　→|C/C++ Sync Suite Reference601/8]]
{{div_end}}