Palm Programmer's Laboratory
Introduction to Conduit Development601/A
コンフィグレーション エントリは、Windows 用のコンジット マネージャと HotSync マネージャが従来通りの方法で登録されるコンジット、通知機能、HotSync マネージャ自身のために保存する名前/値のペアです。C/C++ Sync Suite と COM Sync Suite で提供されるインターフェイスは、あなたがこれらの値を読み込み、書き込みすることを可能にします。
- 重要
- Windows レジストリの中のコンフィグレーション エントリを直接操作しないでください。そうする代わりに、常に CDK でドキュメント化されている API を使ってコンフィグレーション エントリにアクセスしてください。コンフィグレーション エントリの保存は将来変更されるかもしれません。しかし、PalmSource はドキュメント化された API が機能し続けることを保証します。あなたがレジストリに直接アクセスした場合、あなたのコードは将来機能しなくなるかもしれません。
どのように各 Sync Suite の API を使ってコンフィグレーション エントリにアクセスするかの詳細は、C/C++ Sync Suite Companion または COM Sync Suite Companion の「インストーラの作成」という章を参照してください。
コンフィグレーション エントリは以下のグループに分けられます:
コンジット コンフィグレーション エントリ ^TOP^
コンジット コンフィグレーション エントリは、Windows のためのコンジット マネージャが通常通りの方法で登録される各コンジットのために保存する名前/値のペアです。これらはあなたがあなたのコンジットを登録するときに作成されます。C/C++ Sync Suite のコンジット マネージャ API と COM Sync Suite の PDCondMgr と PDConduitInfo オブジェクトは、あなたが登録後にこれらの値を読み込み、書き込みすることを可能にします。さらに、これらの API は、あなたがあなた自身のエントリを作成してそれにアクセスし、それにより、あなたが情報 - あなたはそれをあなたのインストーラ、デスクトップ アプリケーション、コンジットがあなたのコンジットに関連付けする必要がある - を保存することを可能にします。コンジットの登録についての更なる情報は、第 6 章 「コンジットと通知機能の HotSync マネージャへの登録」 を参照してください。
表 A.1 はそれぞれの PalmSource-定義コンジット コンフィグレーション エントリを示しています。これらのエントリのあるものはコンジット登録のために必須であり、あるものはそうではありません。HotSync マネージャによって要求される設定とエントリはコンジットを登録し、それにより HotSync マネージャはそれを呼び出すことができます。登録された各コンジットでは、これらのエントリはいくつかに分かれて存在します。さらに、コンジット マネージャ バージョン 3 以降は各 Windows ユーザのためにこれらのエントリのセットを別々に保存し、それにより、別々のコンジットは各 Windows ユーザのために登録されます。
表 A.1 の「要求」列はそのエントリが必須かどうかを示します - つまり、HotSync マネージャはその値を読み込んでそれに基づいて処理を行わなければならないのかどうか、もしそうであれば HotSync マネージャのどのバージョンがそれを必要とするのかを示しています。多くのエントリは完全にオプションです。あるバージョンの HotSync マネージャに対して必須ではないエントリをあなたがサポートすることを望まないのなら、あなたはその値をセットする必要はありません。
「データ タイプ」列はそれぞれがどのようにコンジット コンフィグレーション エントリに保存されるかを示しています（コンジット マネージャ API に渡されるタイプとは異なるかもしれません）。
さらに、これらのエントリはいくつかはコンジット コンフィグレーション (CondCfg) ユーティリティにアクセスすことができます。CondCfg についての更なる情報は、Conduit Development Utilities Guide の 第 3 章 「コンジット コンフィグレーション ユーティリティ」? を参照してください。
Table A.1
表 A.1 コンジット コンフィグレーション エントリ
| コンフィグレーション エントリ | 要求 [1] | データ タイプ | 説明、取得/セットを行う関数 |
|---|---|---|---|
| Arguments | オプション | string | CDK 6.0 では軽視されます。HotSync マネージャのどのバージョンもこの値を使用しません。 コンジット マネージャ API (C/C++ Sync Suite): CmGetCreatorArgument(), CmSetCreatorArgument() |
| ClassName | Java | string | Java-ベース コンジット クラス（パッケージを含む）の完全な名前です。このエントリは Java-ベース コンジットに対してのみされます。 コンジット マネージャ API (C/C++ Sync Suite): CmGetCreatorValueString(), CmSetCreatorValueString() COM Sync Suite (PDConduitInfo プロパティ): JavaClassName|COM Sync Suite Reference601/5 |
| ClassPath13 | Java | string | 選択された Jaba ベース コンジットによって使用されるすべてのクラスを保持しているディレクトリ。これは Java ベース コンジットによって呼び出されるすべてのクラスを見つけるために必要とされる CLASSPATH の値です。Windows 環境変数 (NT) または autoexec.bat ファイルの中の CLASSPATH 設定は Java ベース コンジットの実行時には無視されます。ClassPath13 エントリは Java ベース コンジットに対してのみ使用されます。(JRE 1.1.3 をベースにした古いバージョンの JSync モジュール用に書かれたコンジットは代わりに ClassPath エントリを使用します。JRE 1.3 をベースにした JSync 用に書かれたすべてのコンジットは ClassPath13 を使用しなければなりません。) コンジット マネージャ API (C/C++ Sync Suite): CmGetCreatorValueString, CmSetCreatorValueString() COM Sync Suite (PDConduitInfo プロパティ): COMClassID|COM Sync Suite Reference601/5 |
| Conduit | すべて | string | コンジット DLL ファイルの名前。このエントリがファイル名だけの場合、DLL は HotSync マネージャの実行形式ファイルのあるディレクトリか現在の Windows ユーザの PATH の中になければなりません。このエントリがパスとファイル名の場合、あなたはその DLL をどのディレクトリにでも配置することができます。 Java ベース コンジットの場合、このエントリは CDK 4.02 以降で開発されたコンジット用の jsync13.dll にセットされなければなりません; あなたのコンジットが CDK 4.02 とともに出荷される JSync モジュールよりも以前のものに対しても機能しなければならない場合、このエントリは jsync.dll でなければなりません。 COM ベース コンジットの場合、このエントリは COMConduit.dll にセットされなければなりません。 コンジット マネージャ API (C/C++ Sync Suite): CmGetCreatorName(), CmSetCreatorName(), CmConduitType2 |
| Creator | すべて | DWORD | あなたのコンジットが同期させる責任を持つハンドヘルド上のアプリケーションの 作成者 ID。この値は HotSync マネージャがあなたのコンジットを一意に識別するための固有キーです。そのため、ある特定の作成者 ID に対して一度にコンジットを 1 つだけ登録することができます。 この値は DWORD として保存されますが、作成者 ID は特別な 4 文字の文字列です。いくつかの API は作成者 ID を DWORD で表し、たの API は文字列として表します。作成者 ID をどちらかの表現から他方に変換する必要がある場合は、提供されるユーティリティ関数を使用します。 コンジット マネージャ API (C/C++ Sync Suite): CmGetCreatorIDList(), CmInstallCreator(), CmConduitType2, CmConvertCreatorIDToString(), CmConvertStringToCreatorID() COM Sync Suite (PDConduitInfo プロパティ): CreatorID|COM Sync Suite Reference601/5 |
| Directory | オプション | string | コンジットのディレクトリ名。これはデスクトップ コンピュータ上のユーザのディレクトリの中にあるサブディレクトリの名前です (フルパスではありません)。各ユーザのディレクトリｎ内部に、各コンジットはファイルを保存するためのディレクトリを持つことができます。例えば、Directory 値が "DateBook" の場合、そのパスは通常 C:\Documents and Settings\<WinUsername>\My Documents\Palm OS Desktop\<HotSyncUsername>\DateBook です。このディレクトリはサポート ファイル - サード パーティのデータベースとのレコード レベル同期を正確に実行するのに必要となるレコード ID マッピング ファイルなど - を保持する可能性がありますｌ。 HotSync マネージャはこの値をコンジットの OpenConduit() または等価のエントリ ポイント経由でコンジットに渡します。 コンジット マネージャ API (C/C++ Sync Suite): CmGetCreatorDirectory(), CmSetCreatorDirectory(), CmConduitType2, CSyncProperties COM Sync Suite (PDConduitInfo プロパティ): DeskTopDataDirectory|COM Sync Suite Reference601/5 |
| File | オプション | string | あなたのコンジットがハンドヘルド データベースと同期させるデスクトップ ファイルの名前。しかしながら、あなたのコンジットは複数のファイルを同期させることができます。このコンフィグレーション エントリはフルパスとファイル名、あるいはファイル名だけという 2 つの可能性があるということに注意してください。値がファイル名だけである場合、そのファイルは Directory エントリで指定されるディレクトリの中で見つかります。 HotSync マネージャはこの値をコンジットの OpenConduit() あるいは等価のエントリ ポイント経由でコンジットに渡します。 コンジット マネージャ API (C/C++ Sync Suite): CmGetCreatorFile(), CmSetCreatorFile(), CmConduitType2, CSyncProperties COM Sync Suite (PDConduitInfo プロパティ): DeskTopDataFile|COM Sync Suite Reference601/5 |
| Information | オプション | string | CDK 6.0 では使用を推奨されなくなりました。どのバージョンの HotSync マネージャもこの値を使用しません。このエントリを使用する代わりに、あなた自身の情報を作成してください。このエントリはあなたがあなたのコンジットに関連付けてたい何らかの文字列を保存します。 コンジット マネージャ API (C/C++ Sync Suite): CmGetCreatorInfo(), CmSetCreatorInfo() |
| Integrate | オプション | DWORD | CDK 6.0 では使用を推奨されなくなりました。どのバージョンの HotSync マネージャもこの値を使用しません。 古いバージョンの Palm OS Desktop アプリケーション用のインストーラは Module の中で指定されたアプリケーションが Palm OS Desktop アプリケーションと統合されるかどうかを指定するためにこの値を使用します。開発者によってインストールされるたいていのコンジットは統合コンジットではなく、新しいバージョンの Palm OS Desktop はこの値をまったく使用しません。 "0" - 統合されない "1" - 統合される コンジット マネージャ API (C/C++ Sync Suite): CmGetCreatorIntegrate(), CmSetCreatorIntegrate() CmInstallCreator() CmInstallConduit() |
| Module | オプション | string | CDK 6.0 では使用を推奨されなくなりました。どのバージョンの HotSync マネージャもこの値を使用しません。 Palm OS Desktop ソフトウェアに統合されるこのコンジットに関連付けされるプラグ インの実行形式のファイルの名前。このエントリは古いバージョンの Palm OS Desktop ソフトウェアによってのみ使用されます; 新しいバージョンは使用しません。 コンジット マネージャ API (C/C++ Sync Sういて): CmGetCreatorModule(), CmSetCreatorModule() |
| Name | オプション | string | コンジットの表示名。HotSync マネージャはこの文字列をコンジットの名前としてユーザ インターフェイス - 例えば、Custom ダイアログ ボックス - に表示します。あなたがこのエントリをセットしなかった場合、HotSync マネージャはあなたのコンジットが C/C++ 同期の GetConduitInfo() または GetConduitName()、JSync の Conduit::name()、COM 同期の IPDClientNotify->GetConduitInfo() によって呼び出されるときに提供する名前を表示します。 コンジット マネージャ API (C/C++ Sync Suite): CmGetCreatorTitle(), CmSetCreatorTitle(), CmConduitType2 COM Sync Suite (PDConduitInfo プロパティ): DisplayName|COM Sync Suite Reference/5 |
| Priority | オプション | DWORD | このコンジットの実行優先度。この値は 0 から 4 までの範囲です。値が指定されていない場合、HotSync マネージャはデフォルト値の 2 を使用します。HotSync マネージャは値 0 を持つコンジットを最初に実行し、値 4 を持つコンジットを最後に実行します。 コンジット マネージャ API (C/C++ Sync Suite): CmGetCreatorPriority(), CmSetCreatorPriority(), CmConduitType2 COM Sync Suite (PDConduitInfo プロパティ): Priority|COM Sync Suite Reference/5 |
| Remote | オプション | string | このコンジットによってアクセスされるハンドヘルド データベースの名前。このオプション エントリは指定されたデータベース名を持つようにハード コードされていないコンジットによって使用される可能性があります。この値はコンジットに渡され、コンジットはハンドヘルド上のデータベースをオープンすることができるようになります。さらにコンジットは指定されたデータベースが同期時に存在しない場合にそのデータベースをハンドヘルド上に作成するためにこの名前を使用することができます。データベース名は大文字/小文字が区別されます (原文: case-sensitive)。 HotSync マネージャはこの値をコンジットの OpenConduit() または等価のエントリ ポイント経由でコンジットに渡します。 コンジット マネージャ API (C/C++ Sync Suite): CmGetCreatorRemote(), CmSetCreatorRemote(), CmConduitType2, CSyncProperties COM Sync Suite (PDConduitInfo プロパティ): HandHeldDB|COM Sync Suite Reference/5 |
| Username | オプション | string | CDK 6.0 では使用を推奨されなくなりました。どのバージョンの HotSync マネージャもこの値を使用しません。 コンジット マネージャ API (C/C++ Sync Suite): CmGetCreatorUser(), CmSetCreatorUser() |
- [1]「すべて」= すべてのコンジットで必須。
- 「オプション」=すべてのコンジットでオプション。
- 「C」= C API-ベース コンジットでのみ必須。
- 「Java」= Java-ベース コンジットでのみ必須。
- 「COM」= COM-ベース コンジットでのみ必須。
インストール コンジット コンフィグレーション エントリ ^TOP^
インストール コンジット コンフィグレーション エントリは Windows 用のインストール コンジットが登録される各インストール コンジットのために保存する名前/値のペアです。これらはあなたがあなたのインストール コンジットを登録するときに作成されます。C/C++ Sync Suite のインストール コンジット マネージャ API と COM Sync Suite のPDInstallConduit と PDInstallConduitInfo オブジェクトはあなたが登録後にこれらの値を読み書きすることを可能にします。さらにこれらの API はあなたがあなた自身のエントリを作成し、それにアクセスすることを可能にし、それによりあなたはあなたのインストーラ、デスクトップ アプリケーション、インストール コンジットがあなたのインストール コンジットに関連付けする必要があるかもしれない情報を保存することができます。コンジットの登録についての更なる情報は、第 6 章 「コンジットと通知機能の HotSync マネージャへの登録」 を参照してください。
表 A.2 は PalmSource 定義のインストール コンジット コンフィグレーション エントリについて説明しています。この表が示すように、これらのエントリの大半はインストール コンジットの登録で必須となります。HotSync マネージャによって必要とされるエントリをセットすることはインストール コンジットを登録することであり、それにより HotSync マネージャはそれを呼び出すことができるようになります。登録された各インストール コンジットに対して、これらのエントリの個別のセットが存在します。さらに、インストール コンジット マネージャ バージョン 3 以降は各 Windows ユーザごとに異なるセットを保存するので、各 Windows ユーザに対して異なるインストール コンジットを登録することが可能です。
表 A.2 の「要求」列はそのエントリが必須であるかどうかを示します - つまり、HotSync マネージャはその値を読み込んで、それに基づいて行動しなければならないかどうか、そうである場合は HotSync マネージャのどのバージョンがそれを必要とするかです。多くのエントリは完全にオプションです。あるエントリが必須であるというマークを付けられていない場合、あなたはそのエントリに対して値をセットする必要はありません。
「データ型」列はそれぞれの値がどのようにコンジット コンフィグレーション エントリに保存されるかを示しています (インストール コンジット マネージャ API に渡される型とは異なるかもしれません)。
表 A.2 インストール コンジット コンフィグレーション エントリ
| コンフィグレーション エントリ | 要求 [2] | データ型 | 説明とその値を取得/セットする関数 |
|---|---|---|---|
| CreatorID | すべて | DWORD | あなたのインストール コンジットに関連付けされる固有 ID。この値はあなたのインストール コンジットを HotSync マネージャに登録するために必須です; しかしながら、HotSync マネージャはあなたのインストール コンジットを一意に識別するために代わりに 値を使用します。インストーラは CreatorID が固有であることを保証する責任があります。この値はかならずしもあなたが PalmSource 社に登録する作成者 ID と関連する必要はありません。しかしながら、あなたの値が固有であるということを保障するための 1 つの方法はあなたが PalmSource 社に登録した作成者 ID を使用することです。 インストール コンジット マネージャ API (C/C++ Sync Suite): ImRegister(), ImRegisterID() ImRegisterSystem(), ImRegisterSystemID() COM Sync Suite (PDInstallConduitInfo プロパティ): UniqueId|COM Sync Suite Reference/5 |
| Directory | すべて | string | あなたのインストール コンジットに関連付けられるインストール ディレクトリの名前。これはデスクトップ コンピュータ上のユーザのディレクトリの中のサブディレクトリです。インストール援助機能は次の HotSync 中にインストールするためにファイルをここにコピーします。更なる情報は、C/C++ Sync Suite Companion の {goto Install Directory Terminology,インストール ディレクトリ用語|C/C++ Sync Suite Companion601/9-1}} を参照してください。 インストール コンジット マネージャ API (C/C++ Sync Suite): ImGetDirectory(), ImSetDirectory() ImGetSystemDirectory(), ImSetSystemDirectory() COM Sync Suite (PDInstallConduitInfo プロパティ): Directory|COM Sync Suite Reference/5 |
| Extension | すべて | string | インストール コンジットがインストールできるファイルのファイル タイプ拡張子。この文字列は標準の Windows CFileDialog フォーマットです - 例えば、以下のようなものです: Palm Applications(*.prc)|*.prc|Palm Databases (*.pdb)|*.pdb|Palm Query Application (*.pqa)|*.pqa インストール コンジット マネージャ API (C/C++ Sync Suite): ImGetExtension(), ImSetExtension() ImGetSystemExtension(), ImSetSystemExtension() COM Sync Suite (PDInstallConduitInfo プロパティ): Extension|COM Sync Suite Reference/5 |
| Mask | すべて | string | あなたのインストール コンジットに関連付けされる固有のビット マスク値。HotSync マネージャはあなたのインストール コンジットを識別するためにこのマスク値を使用します。あなたのインストーラはこの値が固有であることを保証する責任があります。 インストール コンジット マネージャ API (C/C++ Sync Suite): ImGetMask(), ImSetMask() ImGetSystemMask(), ImSetSystemMask() COM Sync Suite (PDInstallConduitInfo プロパティ): Module|COM Sync Suite Reference/5 |
| Name | オプション | DWORD | インストール コンジットのユーザに対して表示される名前。Custom メニューの中で、HotSync マネージャはこの文字列をインストール コンジットの名前として表示します。 インストール コンジット マネージャ API (C/C++ Sync Suite): ImGetName(), ImSetName() ImGetSystemName(), ImSetSystemName() このエントリが存在しない場合、C API ベース コンジットの GetConduitInfo() (または GetConduitName()) エントリ ポイントによって返される値が代わりに表示されます。 COM Sync Suite (PDInstallConduitInfo プロパティ): Name|COM Sync Suite Reference/5 このエントリが存在しない場合、COM ベース コンジットの GetConduitInfo()|COM Sync Suite Reference601/6 エントリ ポイントによって返される値が代わりに表示されます。 |
- [2]「すべて」 = すべてのインストール コンジットで必須。
- 「オプション」=すべてのコンジットでオプション。
HotSync マネージャ コンフィグレーション エントリ ^TOP^
HotSync マネージャ コンフィグレーション エントリは Windows 用のコンジット マネージャまたは HotSync マネージャが HotSync マネージャ自身のために保存する名前/値のペアです。これらのエントリはコンジット特有のものではありません。しかし、HotSync マネージャがすべての Windows ユーザに対してどのように機能するかに影響を与えます。C/C++ Sync Suite のコンジット マネージャ、HotSync マネージャ、インストール援助機能、ユーザ マネージャ API、COM Sync Suite の PDCondMgr と PDHotSyncUtility オブジェクトはあなたがこれらの値を読み込む (そしてその多くの値を書き込む) ことを可能にします。
表 A.3 は各 HotSync マネージャ コンフィグレーション エントリについて説明しています。「データ型」列はそれぞれがどのようにコンフィグレーション エントリに保存されるかを示しています (API 関数に渡される型とは異なるかもしれません)。
表 A.3 HotSync マネージャ コンフィグレーション エントリ
| コンフィグレーション エントリ | データ型 | 説明とその値を取得/セットする API 関数 |
|---|---|---|
| Core\Path | string | 現在の Windows ユーザのための HotSync ユーザ ディレクトリのパス - 例えば、C:\Documents and Settings\<WinUsername>\My Documents\Palm OS Desktop。しかしながら、これはユーザ ディレクトリの名前を含みません。 C/C++ Sync Suite: CmGetCorePath(), UmGetRootDirectory(), PltGetPath() COM Sync Suite: PDUserData|COM Sync Suite Reference601/3.GetRootDirectory()|COM Sync Suite Reference/4, PDInstall|COM Sync Suite Reference601/3.GetPath()|COM Sync Suite Rerence601/4 |
| Core\HotSyncPath | string | デスクトップ コンピュータ上の HotSync マネージャの実行形式ファイルのパスとファイル名 - 例えば、C:\Program Files\PalmSource\Desktop\HotSync.exe。CondMgr.dll や Instaide.dll のようなサポート DLL のパスを取得するには、HotSync.exe ファイル名を取り除きます。 C/C++ Sync Suite: CmGetSystemHotSyncExecPath(), PltGetPath() COM Sync Suite: PDInstall|COM Sync Suite Reference601/3.GetPath()|COM Sync Suite Rerence601/4 |
| HotSync Manager\DirectComPort | string | HotSync マネージャが直接シリアル (ケーブル、クレドル) 同期のためにモニタする COM ポート - 例えば、"COM1"。 C/C++ Sync Suite: CmGetComPort(), CmSetComPort() COM Sync Suite: N/A |
| HotSync Manager\ModemComPort | string | HotSync マネージャがモデム同期のためにモニタする COM ポート - 例えば、"COM1"。 C/C++ Sync Suite: CmGetComPort(), CmSetComPort() COM Sync Suite: N/A |
| HotSync Manager\BackupConduit | string | HotSync マネージャがバックアップ コンジットとして呼び出すコンジットのファイル名。 C/C++ Sync Suite: CmGetBackupConduit(), CmSetBackupConduit() COM Sync Suite: PDCondMgr|COM Sync Suite Reference601/3.GetBackupConduit|COM Sync Suite Reference601/4 |
| HotSync Manager\PCIdentifier | DWORD | PC ID - デスクトップ コンピュータ上の各 Windows ユーザのための固有識別子。同じ Windows ログインを使用する異なる HotSync ユーザは同じ PC ID を持ちます。 C/C++ Sync Suite: CmGetPCIdentifier() COM Sync Suite: N/A |
| HotSync Manager\NotifierN | string | HotSync マネージャが HotSync プロセスの開始時と終了時に呼び出す通知機能のファイル名。通知機能インストール マネージャはそれの API 通知機能を登録するために呼び出されたときに値 N を代入します。 C/C++ Sync Suite: NmRegister(), NmRegisterSystem(), NmGetByIndex(), NmGetSystemByIndex() COM Sync Suite: PDCondMgr|COM Sync Suite Reference601/3.RegisterNotifier|COM Sync Suite Reference601/4, PDCondMgr|COM Sync Suite Reference601/3.GetNotifierList|COM Sync Suite Reference601/4 |
