Palm Programmer's Laboratory
C/C++ Sync Suite Reference601/18
あなたが通知機能を作成する必要がある場合、その通知機能はこの章で説明されているデスクトップ アプリケーション通知機能 API を実装しなければなりません。通知機能 は開発者が彼らのデスクトップ アプリケーションに同期活動について通知するために実装することができるオプションの DLL です。HotSync マネージャは同期を開始する前に登録されているすべての通知機能を呼び出し、デスクトップ アプリケーションにメッセージを渡します。デスクトップ アプリケーションはそのメッセージに従って動作します。例えば、ある通知機能はデスクトップ アプリケーションにデータを保存して、データの変更を停止するように伝えることができます。HotSync マネージャは同期の後に再び通知機能を呼び出し、それにより今度は通知機能はデスクトップ アプリケーションに同期が成功裏に完了したかどうかを知らせることができます。
デスクトップ アプリケーション通知関数は HSNotify.h の中で宣言されています。
この章は以下の節に分かれています:
デスクトップ アプリケーション通知機能定数 ^TOP^
この節では、以下のデスクトップ アプリケーション通知機能 API のための関連プロセッサ定数のグループについて説明します: 通知メッセージ
通知メッセージ ^TOP^
目的
HotSync マネージャが HotSync の最中に通知機能の HS_Notify() 関数を呼び出したときに通知機能に渡すことができるメッセージを定義します。
宣言されている場所
HSNotify.h
定数
- #define HS_SYNC_FAILURE 3
- HotSync マネージャは同期が成功裏には完了しなかったことを示すためにこのメッセージを送ります。あなたの HS_Notify() 実装は HotSync を継続させるために TRUE の値を返さなければなりません。
- #define HS_SYNC_QUERYOK 0
- 同期が開始される前に、HotSync マネージャは各通知機能に同期を開始することができるかどうかを尋ねるためにこのメッセージを送ります。あなたの HS_Notify() 実装は HotSync を継続させるために TRUE の値を返さなければなりません。*#define HS_SYNC_STARTED 1
- HotSync マネージャは同期が開始されたことを示すためにこのメッセージを送ります。あなたの HS_Notify() 実装は HotSync を継続させるために TRUE の値を返さなければなりません。
- #define HS_SYNC_SUCCESS 2
- HotSync マネージャは同期が成功裏に完了したことを示すためにこのメッセージを送ります。あなたの HS_Notify() 実装は HotSync を継続させるために TRUE の値を返さなければなりません。
- #define HS_USER_UPDATE 4
- HotSync マネージャはユーザ データ ファイルが変更されたことを示すためにこのメッセージを送ります。あなたの HS_Notify() 実装は HotSync を継続させるために TRUE の値を返さなければなりません。
互換性
- HotSync マネージャ バージョン: すべて
- Palm OS バージョン: すべて
参照
通知機能定義 API 関数 ^TOP^
この節では、通知機能が実装する以下の関数について説明します。
| 関数 | 説明 |
|---|---|
| GetNotifierVersion | 通知機能定義バージョン番号を返します。 |
| HS_Notify | HotSync マネージャから通知メッセージを受け取り、返り値で HotSync マネージャを継続できるかどうかを示します。 |
GetNotifierVersion 関数 ^TOP^
目的
通知機能定義バージョン番号を返します。
宣言されている場所
HSNotify.h
Prototype
DWORD GetNotifierVersion () typedef DWORD (*PGETNOTIFIERVERSIONFUNC) ()
パラメータ
あるません。
返り値
通知機能のバージョン番号を返します。この値は通知機能によって定義されます。
コメント
GetNotifierVersion() の実装はオプションです。HotSync マネージャはこの関数が返すべきものを定義しませんし、この関数を呼び出しもしません。しかしながら、この関数はあなたの通知機能のバージョンを示すためにこの関数を呼び出すことができるためあなたのデスクトップ アプリケーションにとって有用かもしれません。
互換性
- HotSync マネージャ バージョン: すべて
- Palm OS バージョン: すべて
HS_Notify 関数 ^TOP^
目的
HotSync マネージャから通知メッセージを受け取り、返り値で HotSync マネージャを継続できるかどうかを示します。
宣言されている場所
HSNotify.h
Prototype
BOOL HS_Notify ( int nCode, int nUserId ) typedef BOOL ( *PHSNOTIFYFUNC ) ( int nCode, int nUserId )
パラメータ
- → nCode
- HotSync マネージャからのメッセージ。これは 「通知メッセージ」 で定義されている定数のなかの 1 つです。
- → nUserId
- 同期を行っているユーザの ID。
返り値
あなたの通知機能が HotSync を開始 (訳者補足: 継続も含む) することを望む場合、TRUE を返します。
あなたの通知機能が HotSync を開始 (訳者補足: 継続も含む) することを望まない場合、FALSE を返します。
コメント
通知機能はこの関数を実装しなければなりません。HotSync マネージャは通知機能の HS_Notify() 関数を呼び出して HotSync を開始したユーザの ID (nUserID) と基本的なステータス メッセージ (nCode) を渡します。あなたの HS_Notify() 実装は TRUE の値を返さなければなりません。さもないと、HotSync マネージャは同期を中止します。あなたの通知機能がこれらの最小必須要素以上に何をするかはあなたしだいです。一般的な通知機能はデスクトップ アプリケーションにそのデスクトップ アプリケーションがコンジットにデスクトップ データを同期させる準備が整っているかどうかを問い合わせます。あなたの通知機能は同期操作全体を停止させるために FALSE を返すことができます; 例えば、あなたのデスクトップ アプリケーションが目下のところ同期させるデータにアクセスしている場合にです。
