Palm Programmer's Laboratory
C/C++ Sync Suite Reference601/13
通知機能インストール マネージャ関数は CondMgr.dll の中で使用可能であり (CondMgr.dll はさらにコンジット マネージャ関数を含みます)、CondMgr.h の中で宣言されています。
この章は以下の節に分かれています:
更なる情報は、C/C++ Sync Suite Companion の 第 8 章 「デスクトップ通知機能の作成 を参照してください。
通知機能のパスとファイル名 ^TOP^
いくつかの通知機能インストール マネージャ関数は通知機能ファイル名を引数としてとったり、返したりします。これらの関数は指定された通知機能のコンフィグレーション エントリにアクセスし、そこに書かれていることを返します。これらの関数すべてに対して、あなたは完全に適切なパスを指定することができます。あなたがフル パスを持たないファイル名を指定した場合、HotSync マネージャは HotSync マネージャが起動されたディレクトリの中で通知機能を見つけ出そうとし、それから Windows の PATH 環境変数によって指定されているディレクトリの中を探します; HotSync マネージャは HotSync マネージャ自身の実行ファイルが置かれているディレクトリは見ません。
通知機能インストール マネージャ関数 ^TOP^
この節では、あなたが通知機能を登録、管理することを可能にする以下の関数について説明します。
| 関数 | 説明 |
|---|---|
| NmFind() | ファイル名によって指定されたユーザ登録通知機能のインデックスを取得します。 |
| NmFindSystem() | ファイル名によって指定されたシステム登録通知機能のインデックスを取得します。 |
| NmGetByIndex() | インデックスによって指定されたユーザ登録通知機能のファイル名を取得します。 |
| NmGetCount() | 現在の Windows ユーザのために登録されている通知機能の数を取得します。 |
| NmGetSystemByIndex() | インデックスによって指定されたシステム登録通知機能のファイル名を取得します。 |
| NmGetSystemCount() | システムのために登録されている通知機能の数を取得します。 |
| NmRegister() | 現在の Windows ユーザのための通知機能を HotSync マネージャに登録します。 |
| NmRegisterSystem() | システムのための通知機能を HotSync マネージャに登録します。 |
| NmRenameByIndex() | インデックスによって指定されたユーザ登録通知機能のファイル名を変更します。 |
| NmRenameSystemByIndex() | インデックスによって指定されたシステム登録通知機能のファイル名を変更します。 |
| NmUnregister() | 現在の Windows ユーザのために登録されている通知機能の登録を解除します。 |
| NmUnregisterSystem() | システムのために登録されている通知機能の登録を解除します。 |
NmFind ^TOP^
目的
ファイル名によって指定されたユーザ登録通知機能のインデックスを取得します。
宣言されている場所
CondMgr.h
Prototype
int WINAPI NmFind ( const TCHAR *pNotifier )
パラメータ
- → pNotifier
- 通知機能のファイル名を保持している null で終了する文字バッファへの const ポインタ (「通知機能のパスとファイル名」 を参照してください)。
返り値
成功した場合、指定された通知機能のインデックスを返します (>=0)。
失敗した場合、以下の負値のエラー コード値の 1 つを返します:
- ERR_INVALID_POINTER
- ERR_NOTIFIER_NOT_FOUND
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
通知機能のインデックスは通知機能インストール マネージャによって維持されます。あなたのアプリケーションはこれらのインデックスを追跡したり変更したりする必要はありません; 通知機能インストール マネージャがあなたのためにそれらのことを行います。
この関数は現在の Windows ユーザのために登録されている通知機能についての情報を取得します。システムのために登録されている通知機能のインデックスを取得するには NmFindSystem() を呼び出します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
NmFindSystem ^TOP^
目的
ファイル名によって指定されたシステム登録通知機能のインデックスを取得します。
宣言されている場所
CondMgr.h
Prototype
int WINAPI NmFindSystem ( const TCHAR *pNotifier )
パラメータ
- → pNotifier
- 通知機能のファイル名を保持している null で終了する文字バッファへの const ポインタ (「通知機能のパスとファイル名」 を参照してください)。
返り値
成功した場合、指定された通知機能のインデックスを返します (>=0)。
失敗した場合、以下の負値のエラー コード値の 1 つを返します:
- ERR_INVALID_POINTER
- ERR_NOTIFIER_NOT_FOUND
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
通知機能のインデックスは通知機能インストール マネージャによって維持されます。あなたのアプリケーションはこれらのインデックスを追跡したり変更したりする必要はありません; 通知機能インストール マネージャがあなたのためにそれらのことを行います。
この関数はシステムのために登録されている通知機能についての情報を取得します。現在の Windows ユーザのために登録されている通知機能のインデックスを取得するには NmFind() を呼び出します。
互換性
- コンジット マネージャ バージョン: 3 以降
- Palm OS バージョン: すべて
参照
NmGetByIndex ^TOP^
目的
インデックスによって指定されたユーザ登録通知機能のファイル名を取得します。
宣言されている場所
CondMgr.h
Prototype
int WINAPI NmGetByIndex ( int iIndex, TCHAR *pNotifier, int *piSize )
パラメータ
- → iIndex
- あなたが取得しようとしている通知機能のインデックス (0 ベース)。
- ← pNotifier
- 通知機能のファイル名を保持している null で終了する文字バッファへの const ポインタ (「通知機能のパスとファイル名」 を参照してください)。
- ←→ piSize
- pNotifier パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎたために変換が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。
返り値
成功した場合、0 を返します。
失敗した場合、以下の負値のエラー コード値の 1 つを返します:
- ERR_INVALID_POINTER
- ERR_BUFFER_TOO_SMALL
- あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
- ERR_INDEX_OUT_OF_RANGE
- ERR_NOTIFIER_NOT_FOUND
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数は通知機能のファイル名を取得します。これはコンフィグレーション エントリの HotSync 部に保存されています。
この関数は現在の Windows ユーザのために登録されている通知機能についての情報を取得します。システムのために登録されている通知機能のファイル名を取得するには NmGetSystemByIndex() を呼び出します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
NmGetCount(), NmFind(), NmRenameByIndex()
NmGetCount ^TOP^
目的
現在の Windows ユーザのために登録されている通知機能の数を取得します。
宣言されている場所
CondMgr.h
Prototype
int WINAPI NmGetCount ( DWORD *pdwCount )
パラメータ
- ← pdwCount
- 登録されている通知機能の数にセットされている DWORD へのポインタ。
返り値
成功した場合、0 を返します。
失敗した場合、以下の負値のエラー コード値の 1 つを返します:
- ERR_NOTIFIER_NOT_FOUND
- ERR_STORAGE_ACCESS
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数は現在の Windows ユーザのために登録されている通知機能についての情報を取得します。システムのために登録されている通知機能の数を取得するには、NmGetSystemCount() を呼び出します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
NmGetSystemByIndex ^TOP^
目的
インデックスによって指定されたシステム登録通知機能のファイル名を取得します。
宣言されている場所
CondMgr.h
Prototype
int WINAPI NmGetSystemByIndex ( int iIndex, TCHAR *pNotifier, int *piSize )
パラメータ
- → iIndex
- あなたが取得しようとしている通知機能のインデックス (0 ベース)。
- ← pNotifier
- 通知機能のファイル名を指定する null で終了する文字バッファへのポインタ。
- ←→ piSize
- pNotifier パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎたために変換が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。
返り値
成功した場合、0 を返します。
失敗した場合、以下の負値のエラー コード値の 1 つを返します:
- ERR_INVALID_POINTER
- ERR_BUFFER_TOO_SMALL
- あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
- ERR_INDEX_OUT_OF_RANGE
- ERR_NOTIFIER_NOT_FOUND
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数は通知機能のファイル名を取得します。これはコンフィグレーション エントリの HotSync 部に保存されています。
この関数はシステムのために登録されている通知機能についての情報を取得します。現在の Windows ユーザのために登録されている通知機能のファイル名を取得するには、NmGetByIndex() を呼び出します。
互換性
- コンジット マネージャ バージョン: 3 以降
- Palm OS バージョン: すべて
参照
NmGetSystemCount(), NmFindSystem(), NmRenameSystemByIndex()
NmGetSystemCount ^TOP^
目的
システムのために登録されている通知機能の数を取得します。
宣言されている場所
CondMgr.h
Prototype
int WINAPI NmGetSystemCount ( DWORD *pdwCount )
パラメータ
- ← pdwCount
- 登録されている通知機能の数にセットされている DWORD へのポインタ。
返り値
成功した場合、0 を返します。
失敗した場合、以下の負値のエラー コード値の 1 つを返します:
- ERR_NOTIFIER_NOT_FOUND
- ERR_STORAGE_ACCESS
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数はシステムのために登録されている通知機能についての情報を取得します。現在の Windows ユーザのために登録されている通知機能の数を取得するには、NmGetCount() を呼び出します。
互換性
- コンジット マネージャ バージョン: 3 以降
- Palm OS バージョン: すべて
参照
NmRegister ^TOP^
目的
現在の Windows ユーザのための通知機能を HotSync マネージャに登録します。
宣言されている場所
CondMgr.h
Prototype
int WINAPI NmRegister ( const TCHAR *pNotifierPath )
パラメータ
- → pNotifierPath
- HotSync マネージャに登録する通知機能のファイル名を指定している null で終了する文字バッファへのポインタ (「通知機能のパスとファイル名」 を参照してください)。
返り値
成功した場合、0 を返します。
失敗した場合、以下の負値のエラー コード値の 1 つを返します:
- ERR_ALREADY_INSTALLED
- ERR_INVALID_POINTER
- ERR_STORAGE_ACCESS
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数は通知機能のパスをコンフィグレーション エントリに保存することによって、現在の Windows ユーザのために通知機能を登録します。システムのために通知機能を登録するには、NmRegisterSystem() を呼び出します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
NmRegisterSystem ^TOP^
目的
システムのための通知機能を HotSync マネージャに登録します。
宣言されている場所
CondMgr.h
Prototype
int WINAPI NmRegisterSystem ( const TCHAR *pNotifierPath )
パラメータ
- → pNotifierPath
- HotSymc マネージャに登録される通知機能のファイル名を指定している null で終了する文字バッファへのポインタ (「通知機能のパスとファイル名」 を参照してください)。
返り値
成功した場合、0 を返します。
失敗した場合、以下の負値のエラー コード値の 1 つを返します:
- ERR_ALREADY_INSTALLED
- ERR_INVALID_POINTER
- ERR_STORAGE_ACCESS
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数は通知機能のパスをコンフィグレーション エントリに保存することによって、システムのために通知機能を登録します。現在の Windows ユーザのために通知機能を登録するには、NmRegister() を呼び出します。
互換性
- コンジット マネージャ バージョン: 3 以降
- Palm OS バージョン: すべて
参照
NmRenameByIndex ^TOP^
目的
インデックスによって指定されたユーザ登録通知機能のファイル名を変更します。
宣言されている場所
CondMgr.h
Prototype
int WINAPI NmRenameByIndex ( int iIndex, const TCHAR *pNotifier )
パラメータ
- → iIndex
- あなたがリネームしようとしている通知機能のインデックス (0 ベース)。
- → pNotifier
- 通知機能のファイル名を指定している null で終了する文字バッファへのポインタ (「通知機能のパスとファイル名」 を参照してください)。
返り値
成功した場合、0 を返します。
失敗した場合、以下の負値のエラー コード値の 1 つを返します:
- ERR_INVALID_POINTER
- ERR_INVALID_PATH
- ERR_INDEX_OUT_OF_RANGE
- ERR_NOTIFIER_NOT_FOUND
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数はコンフィグレーション エントリの中の HotSync 部に値の 1 つとして保存されている通知機能のファイル名を変更します。
- 重要
- 通知機能を削除する手段として pNotifier に NULL をセットしてはいけません。HotSync マネージャはそのような通知機能を呼び出そうとしたときにエラー メッセージを表示します。代わりに、NmUnregister() を使用します。
この関数は現在の Windows ユーザのために登録されている通知機能の情報をセットします。システムのために登録されている通知機能のファイル名をセットするには、NmRenameSystemByIndex() を呼び出します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
NmRenameSystemByIndex ^TOP^
目的
インデックスによって指定されたシステム登録通知機能のファイル名を変更します。
宣言されている場所
CondMgr.h
Prototype
int WINAPI NmRenameSystemByIndex ( int iIndex, const TCHAR *pNotifier )
パラメータ
- → iIndex
- あなたがリネームしようとしている通知機能のインデックス (0 ベース)。このインデックスはコンフィグレーション エントリ名 - つまり、Notifier0, Notifier1 など - に基づくものではないということに注意してください。そうではなく、通知機能インストール マネージャによって維持される独立したインデックスです。
- → pNotifier
- 通知機能のファイル名を指定している null で終了する文字バッファへのポインタ (「通知機能のパスとファイル名」 を参照してください)。
返り値
成功した場合、0 を返します。
失敗した場合、以下の負値のエラー コード値の 1 つを返します:
- ERR_INVALID_POINTER
- ERR_INVALID_PATH
- ERR_INDEX_OUT_OF_RANGE
- ERR_NOTIFIER_NOT_FOUND
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数はコンフィグレーション エントリの中の HotSync 部に値の 1 つとして保存されている通知機能のファイル名を変更します。
- 重要
- 通知機能を削除する手段として pNotifier に NULL をセットしてはいけません。HotSync マネージャはそのような通知機能を呼び出そうとしたときにエラー メッセージを表示します。代わりに、NmUnregisterSystem() を使用します。
この関数はシステムのために登録されている通知機能の情報をセットします。現在の Windows ユーザのために登録されている通知機能のファイル名をセットするには、NmRenameByIndex() を呼び出します。
互換性
- コンジット マネージャ バージョン: 3 以降
- Palm OS バージョン: すべて
参照
NmUnregister ^TOP^
目的
現在の Windows ユーザのために登録されている通知機能の登録を解除します。
宣言されている場所
CondMgr.h
Prototype
int WINAPI NmUnregister ( const TCHAR *pNotifierPath )
パラメータ
- → pNotifierPath
- HotSync マネージャから登録を解除される通知機能のファイル名を指定している null で終了する文字バッファへのポインタ (「通知機能のパスとファイル名」 を参照してください)。
返り値
成功した場合、0 を返します。
失敗した場合、以下の負値のエラー コード値の 1 つを返します:
- ERR_INVALID_POINTER
- ERR_NOTIFIER_NOT_FOUND
- ERR_STORAGE_ACCESS
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数は現在の Windows ユーザのために登録されている通知機能の登録を解除します。コンフィグレーション エントリから通知機能のパスを削除することによって通知機能の登録を解除しますが、通知機能 DLL 自体を削除するわけではありません。システムのための通知機能の登録を解除するには、NmUnregisterSystem() を呼び出します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
NmUnregisterSystem ^TOP^
目的
システムのために登録されている通知機能の登録を解除します。
宣言されている場所
CondMgr.h
Prototype
int WINAPI NmUnregisterSystem ( const TCHAR *pNotifierPath )
パラメータ
- → pNotifierPath
- HotSync マネージャから登録を解除される通知機能のファイル名を指定している null で終了する文字バッファへのポインタ (「通知機能のパスとファイル名」 を参照してください)。
返り値
成功した場合、0 を返します。
失敗した場合、以下の負値のエラー コード値の 1 つを返します:
- ERR_INVALID_POINTER
- ERR_NOTIFIER_NOT_FOUND
- ERR_STORAGE_ACCESS
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数はシステムのために登録されている通知機能の登録を解除します。コンフィグレーション エントリから通知機能のパスを削除することによって通知機能の登録を解除しますが、通知機能 DLL 自体を削除するわけではありません。現在の Windows ユーザのための通知機能の登録を解除するには、NmUnregister() を呼び出します。
互換性
- コンジット マネージャ バージョン: 3 以降
- Palm OS バージョン: すべて
参照
