Palm Programmer's Laboratory
C/C++ Sync Suite Reference601/0
C/C++ Sync Suite は、PalmSource 社が提供する Windows のための Palm OS Conduit Development Kit (CDK) のコンポーネントの 1 つです。これは、開発者が Windows コンピュータ上で実行される C API ベース コンジットを作成するのを助けるために API、C++ Generic Conduit Framework、サンプル、ドキュメント、ユーティリティを提供します。Palm OS プラットフォームの成功への鍵であるコンジットは、デスクトップ コンピュータ上で実行されているアプリケーションと Palm ハンドヘルド間でデータの交換と同期を行うソフトウェア オブジェクトです。
この C/C++ Sync Suite Reference は、あなたがコンジットを開発するために使用できるすべての定数、データ構造体、クラス、関数、メソッドのための完全な参照情報を提供します。
この導入部は以下のパートに分かれています。
関連ドキュメント ^TOP^
ここに書かれているドキュメントの最新バージョンは、以下の URL で見つけることができます。
http://www.palmos.com/dev/support/docs/
以下のドキュメントは CDK の一部です:
ドキュメント | 説明 |
---|---|
Introduction to Conduit Development | Windows プラットフォームでのコンジットの導入。コンジットが Palm OS プラットフォームの他の側面とどのように関係するのか、コンジットがどのように HotSync マネージャと通信するのか、どのようにコンジット開発へのアプローチを選択するのかを説明しています。新たにコンジットを開発する開発者が読むことをお勧めします。 |
C/C++ Sync Suite Companion | C API-ベース コンジットがどのように機能するのか、どのように C/C++ Sync Suite でそれらを開発するのかの概要。 |
C/C++ Sync Suite Reference | C/C++ Sync Suite でコンジットを開発するために使用されるすべてのコンジット関数呼び出しと重要なデータ構造体についての C API リファレンス。 |
COM Sync Suite Companion? | COM ベースのコンジットがどのように機能するのか、COM Sync Suite を使ってどのようにそれらのコンジットを開発するのかについての概要。 |
COM Sync Suite Reference? | COM Sync Suite オブジェクトの階層、各オブジェクト、メソッド、プロパティの詳細についてのリファレンス。 |
Conduit Development Utilities Guide? | 開発者が Windows 用のコンジットを作成、デバッグするのを助ける CDK ユーティリティのガイド。 |
本書に書かれていること ^TOP^
ここでは本書の主要なパートと各章ごとの概観を提供します。
- パート I 「同期マネージャ API」 コンジットだけが HotSync の最中に 3 つの異なるタイプの Palm OS データベースの 1 つとあなたのデスクトップ データ ソースとを同期させるために呼び出すことができる同期マネージャ API について説明します。
- 第 1 章 「同期マネージャ API の概要」 同期マネージャ API が個々のヘッダ ファイルの中でどのように宣言されているかについて説明します。各ヘッダ ファイルは各データベース タイプのためのものであり、そこに含まれる API はそれぞれのタイプのデータベースに対して機能します。
- 第 2 章 「スキーマ同期マネージャ API」? スキーマ Palm OS データベースのための同期マネージャ関数、定数、クラス、データ構造体について説明します。
- 第 3 章 「拡張同期マネージャ API」? 拡張 Palm OS データベースのための同期マネージャ関数、定数、クラス、データ構造体について説明します。
- 第 4 章 「クラシック同期マネージャ API」 クラシック Palm OS データベースのための同期マネージャ関数、定数、クラス、データ構造体について説明します。
- 第 5 章 「共通同期マネージャ API」 すべてのタイプのデータベースのために使用されるか、データベース タイプに依存しない同期マネージャ関数、定数、クラス、データ構造体について説明します。
- パート II 「コンジット API」 コンジットだけが HotSync の最中に呼び出せるコンジット エントリ ポイントと他の API について説明します。
- 第 6 章 「コンジット エントリ ポイント API」 コンジット API 関数 - これらは、あなたのコンジットが HotSync マネージャ アプリケーションと通信するために実装しなければならない関数です - について説明します。
- 第 7 章 「HotSync ログ API」 HotSync ログ関数 - これは、あなたが HotSync ログにアクセスするために使用することができます - について説明します。
- 第 8 章 「Palm OS 一般言語 API」 コンジットが言語リソース DLL をロード、アンロードできるようにするためにあなたが使用可能な Palm OS 一般言語 API について説明します。
- 第 9 章 「拡張マネージャ API」 あなたがハンドヘルドの中にある拡張カードについての情報を取得するために使用できる拡張マネージャ関数、定数、データ構造体について説明します。
- 第 10 章 「仮想ファイル システム マネージャ API」? あなたがハンドヘルドの中にある拡張カード上のファイル システムにアクセスするために使用できる VFS マネージャ関数、定数、データ構造体について説明します。
- パート III 「デスクトップ サポート API」 デスクトップ アプリケーションとインストーラが呼び出せる - 通常は HotSync の最中でないときに - API について説明します。しかしながら、それらのいくつかは HotSync の最中にコンジットによって呼び出される可能性があります。
- 第 11 章 「コンジット マネージャ API」 あなたがあなたのコンジットをインストールまたはアンインストールするために使用できるコンジット マネージャ関数、定数、データ構造体について説明します。
- 第 12 章 「インストール コンジット マネージャ API」 あなたがあなたのインスール コンジットをインストールまたはアンインストールするために使用できるインストール コンジット マネージャ関数、定数、データ構造体について説明します。
- 第13 章 「通知機能インストール マネージャ API」 あなたがあなたのデスクトップ通知機能をインストールまたはアンインストールするために使用できる通知機能インストール マネージャ関数、定数、データ構造体について説明します。
- 第 14 章 「HotSync マネージャ API」 あなたが HotSync マネージャの基本的な機能 (開始、停止、など) を制御するために使用できる HotSync マネージャ API について説明します。
- 第 15 章 「インストール援助機能 API」 あなたがデスクトップからアプリケーションとデータベースをハンドヘルドのメイン メモリにインストールするため、ファイルを拡張カードにインストールするために使用できる関数について説明します。
- 第 16 章 「ユーザ データ API」 あなたがデスクトップ コンピュータとの同期を行ったユーザについての情報にアクセスするために使用できるユーザ データ関数について説明します。
- 第 17 章 「パスワード ライブラリ」 あなたがパスワードを検証するために使用できるパスワード ライブラリについて説明します。
- 第 18 章 「デスクトップ アプリケーション通知機能 API」 デスクトップ アプリケーション通知機能の API について説明します。あなたの通知機能はこの API を実装し、それによって HotSync マネージャはその通知機能のメッセージを HotSync の開始時と終了時に送信できるようになります。
- パート IV 「付録」 すべての C/C++ 関数とエラー コードの要約を提供します。
- 付録 A 「改訂履歴」 Windows のための CDK の各リリースでの C/C++ Sync Suite の中にある API への変更の詳細。
- 付録 B 「プライベート関数と古い関数」 あなたがソース コードの中で見つけるかもしれないが、あなたのコンジットの中では使用できないプライベート システム関数の要約。
本書の変更点 ^TOP^
ここでは本書の各バージョンで行われた主要な変更について説明します。CDK の各バージョンでの C/C++ Sync Suite API への追加、変更については、付録 A 「改訂履歴」 を参照してください。
CDK 6.0.1 のためのドキュメント 3012-006 ^TOP^
このドキュメント バージョンでの主要な修正と追加は以下に章ごとにリストアップされています:
- 第 4 章 「クラシック同期マネージャ API」
- CCallModuleParams と SyncCallRemoteModule() はクラシック データベースに対してのみ機能するため、それを反映させるためにこの章に移動しました。
- SyncReadAppPreference() と SyncWriteAppPreference() は Palm OS Cobalt ハンドヘルドと Palm OS Garnet ハンドヘルドの両方に対して機能する関数であるという説明を追加しました。
- 第 5 章 「共通同期マネージャ API」
- CSystemInfo に HotSync マネージャ バージョン 6.0 以降はハンドヘルドの Palm OS バージョン番号をデスクトップ上のユーザ データ保存場所に保存するという注意書きを加えました。
- 第 7 章 「HotSync ログ API」
- Activity に slSyncFinished と slSyncStarted は HotSync 全体ではなくコンジットの同期セッションを参照するという注意書きを加えました。
- 第 16 章 「ユーザ データ API」
- UmGetInteger() にユーザ データ保存場所からどのようにハンドヘルドの Palm OS バージョン番号を取得するかについての説明を加えました。
- 「ファイル リンク API」という章は、その機能が HotSync マネージャ 6.0.1 ではサポートされなくなったために、削除されました。
- 付録 A 「改訂履歴」 以下の節が追加されました。
CDK 6.0 のためのドキュメント 3012-005 ^TOP^
主要な変更は以下に章ごとにリストアップされています:
- 第 2 章 「スキーマ同期マネージャ API」?
- 「テーブル行データ タイプ」|C/C++ Sync Suite Reference601/2 の中の日付と時刻データについての詳細を追加しました。
- SyncDbCreateRow()|C/C++ Sync Suite Reference601/2 に列値を持たない行を作成する方法についての説明を追加しました。
- SyncDbCreateRows()|C/C++ Sync Suite Reference601/2 にコンジットはリストアの最中にだけ行 ID を指定できるということを追加しました。
- SyncDbRemoveTable()|C/C++ Sync Suite Reference601/2 にこの関数は非デフォルトのソート インデックスを保持するテーブルを削除することはできないということを追加しました。
- SyncDbWriteRows()|C/C++ Sync Suite Reference601/2 に行のカテゴリ帰属を削除する方法についての説明を追加しました。
- 第 3 章 「拡張同期マネージャ」?
- 各関数が返す可能性のあるエラー コードのリストを修正しました。
- SyncDmReadNextModifiedRecord()|C/C++ Sync Suite Reference601/3 に反復ポインタを進めずにキャッシュの中にある味読のデータを取得する方法についての説明を追加しました。
- 第 4 章 「クラシック同期マネージャ API」
- eFirstSync 列挙値の意味を明記しました。
- SyncCallRemoteModule() 呼び出しの結果が稀に不確定になるということを追加しました。
- SyncReadSysDateTime() と SyncWriteSysDateTime() に日付と時刻を提供するためのフォーマットについての説明を追加しました。
- 第 10 章 「仮想ファイル システム マネージャ API」?
- VFSExportDatabaseToFile()|C/C++ Sync Suite Reference601/10 と VFSImportDatabaseFromFile()|C/C++ Sync Suite Reference601/10 はスキーマ データベースに対しては機能しないという注意書きを追加しました。
- 第 14 章 「HotSync マネージャ API」
- HotSync マネージャ バージョン 6.0 以降に新たに登録されたコンジットを認識させるために HsRefreshConduitInfo() または HsSetAppStatus() を呼び出す必要はないという注意書きを追加しました。
CDK 6.0 のためのドキュメント 3012-004 ^TOP^
このドキュメント バージョンでの大半の変更点は同期マネージャ バージョン 2.4 (HotSync マネージャ 6.0) に追加された新しい機能についてです。これらと他の変更点は以下に章の順番にリストアップされています:
- 第 1 章 「同期マネージャ API の概要」 この章が追加されました。
- 第 2 章 「スキーマ同期マネージャ API」? この章が追加されました。
- 第 3 章 「拡張同期マネージャ API」? この章が追加されました。
- 第 4 章 「クラシック同期マネージャ API」 この章を Sync*.h ヘッダ ファイルと整合するように再編成しました。
- 第 5 章 「共通同期マネージャ API」 この章が追加されました。
- 第 7 章 「HotSync ログ API」
- 「HotSync ログ API の変更点」 で説明されているこの API の変更点についてドキュメント化しました。
- LogAddFormattedEntry() のバグをドキュメント化しました。
- 第 9 章 「ファイル リンク API」
- SubDupSubscCategory() が返す可能性のある値のリストから CATEGORY_REGULAR を削除しました。この関数は指定されたカテゴリ名がファイル リンク カテゴリとして使用中であるかどうかだけを決定し、カテゴリが存在するかどうかは決定しません。
- 第 11 章 「コンジット マネージャ API」
- 「コンジット マネージャ API, バージョン 3 の変更点」 で説明されているこの API の変更点をドキュメント化しました。
- コンジット コンフィグレーション エントリの定義を Introduction to Conduit Development の 付録 A 「コンフィグレーション エントリ」 に移動しました。
- 第 12 章 「インストール コンジット マネージャ API」
- 「インストール コンジット マネージャ API, バージョン 3 の変更点」 で説明されているこの API の変更点をドキュメント化しました。
- ImUnregisterID() の成功時の返り値は 0 であると変更しました。返り値は 1 であると述べていましたが誤りです。
- 第 14 章 「HotSync マネージャ API」
- HsResetComm() の説明を修正しました。この関数は HotSync がリスタートされたときにローカル シリアルを除くすべての転送を使用不可にすると述べていましたが誤りです。
- 第 17 章 「同期マネージャ API」
- PwdVerify() の説明を明記しました。ハンドヘルド上のパスワードの文字はすべて小文字として保存されると述べていましたが誤りです。実際は、Palm OS バージョンが 4.0 よりも前であれば当てはまります。Palm OS バージョン 4.0 以降では、パスワードは大文字/小文字を区別されます。
追加リソース ^TOP^
- ドキュメント
- PalmSource 社(訳者注: 現 ACCESS 社)は以下で、本書と Palm OS 開発者のための他のドキュメントの最新バージョンを発行しています。
http://www.palmos.com/dev/support/docs/
- PalmSource 社(訳者注: 現 ACCESS 社)は以下で、本書と Palm OS 開発者のための他のドキュメントの最新バージョンを発行しています。
- トレーニング
- PalmSource とそのパートナーは Palm OS 開発者のためのトレーニング クラスを主催します。トピックスとスケジュールは以下をチェックしてください。
http://www.palmos.com/dev/training
- PalmSource とそのパートナーは Palm OS 開発者のためのトレーニング クラスを主催します。トピックスとスケジュールは以下をチェックしてください。
- ナレッジ ベース
- ナレッジ ベースは高速な Web-ベースの技術情報データベースです。FAQ、サンプル コード、白書、開発文書は以下を探してください。
http://www.palmos.com/dev/support/kb/
- ナレッジ ベースは高速な Web-ベースの技術情報データベースです。FAQ、サンプル コード、白書、開発文書は以下を探してください。
- CDK フィードバック
- CDK のフィードバック - あなたが望む機能、バグ レポート、ドキュメントの誤り、ナレッジ ベースの記事のリクエスト - を行うために以下の email アドレスを使用してください。
cdk-feedback@palmsource.com
- CDK のフィードバック - あなたが望む機能、バグ レポート、ドキュメントの誤り、ナレッジ ベースの記事のリクエスト - を行うために以下の email アドレスを使用してください。
本書の慣習 ^TOP^
このガイドは以下の記述慣習を使用します。
このスタイルは... | 以下のために使用されます。 |
---|---|
sample | ファイル名、コマンド、関数などのコードの要素、構造体、などのリテラル テキスト。 |
sample | 強調または変数を示すため。 |
sample | 用語の定義または最初の使用、メニューとメニュー アイテムの名前、ユーザ供給テキスト、UI 説明の中のウィンドウ名。 |
sample | ハイパーテキスト リンク。 |
→ | 関数に渡されるパラメータ。 |
← | 関数から返されるパラメータ。 |
←→ | 関数に渡されるて返されるパラメータ。 |