Palm Programmer's Laboratory

トップ 差分 一覧 ソース 検索 ヘルプ RSS ログイン

C/C++ Sync Suite Reference601/5-1

←　4 章に戻る　↑トップへ　6 章に進む　→

5 共通同期マネージャ API (ページ 1)

↑　5 章のトップへ 5 章のページ 2 へ　→

共通同期マネージャ クラス ^TOP^

この節では、スキーマ、拡張、クラシック、および共通同期マネージャ関数がパラメータとして取るクラスについて説明します。さらにコンジット エントリ ポイント API で使用されるいくつかのクラスも含みます。これらのクラスはデータ メンバだけを定義し、メソッドは定義しません。

クラス 説明
CCallApplicationParams SyncCallDeviceApplication() がハンドヘルド上のアプリケーション/モジュールと受け渡しを行う情報を定義します。
CCardInfo ハンドヘルド上のメモリ カードについての情報を定義します。SyncReadSingleCardInfo() で使用されます。
CDbList ハンドヘルド上のデータベースについての情報を受け取ります。
CSyncPreference HotSync マネージャがコンジットの ConfigureConduit() エントリ ポイントを呼び出したときに HotSync マネージャとコンジットの間で転送される情報を指定します。
CSyncProperties HotSync マネージャがコンジットの OpenConduit() エントリ ポイントを呼び出したときに現在のコンジットの同期操作のプロパティを指定します。
CSystemInfo SyncReadSystemInfo() がハンドヘルドから受け取るシステム情報を定義します。
CUserIDInfo SyncReadUserID() が返す現在のハンドヘルド ユーザについての情報を定義します。

CCallApplicationParams ^TOP^

目的

SyncCallDeviceApplication() が Palm OS Cobalt ハンドヘルド上のアプリケーションと受け渡しする情報を定義します。

宣言されている場所

SyncCommon.h

Prototype

class CCallApplicationParams {
   public:
   char m_dbName[SYNC_DB_NAMELEN];
   UInt32 m_dwCreatorID;
   UInt32 m_dwTypeID;
   UInt16 m_wAttributes;
   UInt16 m_wActionCode;
   UInt32 m_dwParamSize;
   void *m_pParam;
   UInt32 m_dwResultBufSize;
   void *m_pResultBuf;
   UInt32 m_dwResultCode;
   UInt32 m_dwActResultSize;
   UInt32 m_dwReserved;
}

データ メンバ

  • m_dbName
    • ターゲット アプリケーションの データベース名 を指定する TCHAR ポインタ。
  • m_dwCreatorID
  • m_dwTypeID
    • ターゲット アプリケーションの データベース タイプ ID を指定します。タイプはクロス チェックとしてのみ使用され、あなたがデータベース タイプが何であるか気にしない場合は 0 にセットされるかもしれません。
  • m_wAttributes
    • ターゲット アプリケーションがクラシック データベース、拡張データベース、スキーマ データベースのどれであるのかを指定する dmHdrAttr... ビットの組み合わせ。他のすべての dmHdrAttr ビットは無視されます。これらのビットについての説明は、「データベース属性」 を参照してください。
  • m_wActionCode
    • 実行するアクションを指定するアプリケーション特有のコード。
  • m_dwParamSize
    • m_pParam 配列のバイト数を指定します。
  • m_pParam
    • パラメータ ブロックへのポインタを指定します。
  • m_dwResultBufSize
    • m_pResultBuf 配列の総バイト数を指定します。
  • m_pResultBuf
    • 結果を収めるバッファへのポインタを指定します。
  • m_dwResultCode
    • ハンドヘルド アプリケーションから返される結果コードを受け取ります。
  • m_dwActResultSize
    • 結果コードの実際のサイズを受け取ります。
  • m_dwReserved
    • 将来使用するために予約されています。呼び出し元は同期マネージャ関数を呼び出す前にこのメンバを NULL (0) にセットしなければなりません。

コメント

このクラスは CCallModuleParams に似ています。しかしながら、あなたがターゲット アプリケーションをクリエイタ ID、データベース名、データベース属性 (クラシック、拡張、スキーマ) で一意に識別されたターゲット アプリケーションを呼び出すことを可能にするために SyncCallDeviceApplication() でのみ使用されます。

あなたのバッファがすべての結果データを収めるのに十分な大きさがない場合、m_dwActResultSize の値は m_dwResultBufSize の値よりも大きくなります。そのようなケースでは、関数はデータの dwResultBufSize バイト分だけをバッファにコピーします。

互換性

  • 同期マネージャ バージョン: 2.5 以降
  • Palm OS バージョン: Palm OS Cobalt, バージョン 6.0.1 以降

参照

SyncCallDeviceApplication()

CCardInfo ^TOP^

目的

ハンドヘルド上のメモリ カードについての情報を定義します。SyncReadSingleCardInfo() で使用します。

宣言されている場所

SyncCommon.h

Prototype

class CCardInfo {
   public:
   HSByte m_CardNo;
   UInt16 m_CardVersion;
   SInt32 m_CreateDate;
   UInt32 m_RomSize;
   UInt32 m_RamSize;
   UInt32 m_FreeRam;
   HSByte m_CardNameLen;
   HSByte m_ManufNameLen;
   char m_CardName[SYNC_REMOTE_CARDNAME_BUF_SIZE];
   char m_ManufName[SYNC_REMOTE_MANUFNAME_BUF_SIZE];
   UInt16 m_romDbCount;
   UInt16 m_ramDbCount;
   UInt32 m_dwReserved;
}

データ メンバ

  • m_CardNo
    • 読み込むメモリ カードの番号を指定します。
  • m_CardVersion
    • メモリ カードのバージョンを受け取ります。
  • m_CreateDate
    • メモリ カードの作成日付を受け取ります。これは time_t 値です。
  • m_RomSize
    • メモリ カード上の ROM の量を受け取ります。
  • m_RamSize
    • メモリ カード上の RAM の総量を受け取ります。
  • m_FreeRam
    • メモリ カード上の利用可能な RAM の量を受け取ります。Palm OS バージョン特有の詳細については、SyncReadSingleCardInfo() を参照してください。
  • m_CardNameLen
    • メモリ カード名の文字数を受け取ります。
  • m_ManufNameLen
    • m_ManufName の文字数を受け取ります。
  • m_CardName
    • メモリ カード名を文字配列で受け取ります。
  • m_ManufName
    • 製造者名を文字配列で受け取ります。
  • m_romDbCount
    • メモリ カード上の ROM ベース データベースの数を受け取ります。
  • m_ramDbCount
    • メモリ カード上の RAM ベース データベースの数を受け取ります。
  • m_dwReserved
    • 将来使用するために予約されています。同期マネージャ関数を呼び出す前に呼び出し元はこのメンバを NULL (0) をセットしなければなりません。

互換性

  • 同期マネージャ バージョン: すべて
  • Palm OS バージョン: すべて

参照

SyncReadSingleCardInfo()

CDbList ^TOP^

目的

ハンドヘルド上のデータベースについての情報を受け取ります。

宣言されている場所

SyncCommon.h

Prototype

class CDbList {
   public:
   SInt32 m_CardNum;
   UInt16 m_DbFlags;
   UInt32 m_DbType;
   char m_Name[SYNC_DB_NAMELEN];
   UInt32 m_Creator;
   UInt16 m_Version;
   UInt32 m_ModNumber;
   UInt16 m_Index;
   SInt32 m_CreateDate;
   SInt32 m_ModDate;
   SInt32 m_BackupDate;
   SInt32 m_miscFlags;
   SInt32 m_RecCount;
   SInt32 m_dwReserved;
}

データ メンバ

  • m_CardNum
    • データベースが保存されているメモリ カードの番号を受け取ります。システムの中にある最初のメモリ カードはカード番号 0 であり、それに続くカード番号は +1 されていきます。
  • m_DbFlags
    • 1 つまたは複数のデータベース特性 (クラシック レコード データベース、クラシック リソース データベース、拡張データベース、スキーマ データベースのどれであるか、バックアップされるかどうかなど) を示す eDbFlags 値の組み合わせを受け取ります。
  • m_DbType
    • 4 バイトのデータベース タイプを受け取ります。Palm OS は特別な振る舞いを 'DATA', 'data', 'appl', 'panl', 'libr' を含むいくつかの識別値と連携させます。
  • m_Name
    • データベースの名前をサイズ SYNC_DB_NAMELEN の文字配列として受け取ります。
  • m_Creator
    • データベースのクリエイタ ID を受け取ります。
  • m_Version
    • データベースのバージョンを受け取ります。
  • m_ModNumber
    • データベースの変更番号を受け取ります。この値はデータベースのレコードがハンドヘルド上で追加、変更、削除されるたびに +1 されます。
  • m_Index
  • m_CreateDate
    • データベースが作成された日付を受け取ります。これは time_t 値です。
  • m_ModDate
    • データベースが最も最近に変更された日付を受け取ります。これは time_t 値です。NOTE: Palm OS のバージョン 1.x は変更日付を更新しません。
  • m_BackupDate
    • データベースが最も最近にバックアップされた日付を受け取ります。これは time_t 値です。
  • m_miscFlags
    • 1 つまたは複数の eMiscDbListFlags 値の組み合わせを受け取ります。
  • m_RecCount
    • 使用されません。
  • m_dwReserved
    • 将来使用するために予約されています。同期マネージャ関数を呼び出す前に呼び出し元はこのメンバを NULL (0) をセットしなければなりません。

互換性

  • 同期マネージャ バージョン: すべて
  • Palm OS バージョン: すべて

参照

SyncReadDBList(), SyncDatabaseInfoType, SyncReadOpenDbInfo(), SyncFindDbByName(), SyncFindDbByTypeCreator(), CSyncProperties

CSyncPreference ^TOP^

目的

HotSync マネージャがコンジットの ConfigureConduit() エントリ ポイントを呼び出したときに HotSync マネージャとコンジット間で転送される情報を指定します。

宣言されている場所

SyncCommon.h

Prototype

class CSyncPreference {
   public:
   char m_PathName[BIG_PATH];
   char m_Registry[BIG_PATH];
   HKEY m_hKey;
   eSyncPref m_SyncPref;
   eSyncTypes m_SyncType;
   UInt32 m_dwReserved;
}

データ メンバ

  • m_PathName
    • デスクトップ コンピュータ上のファイル名に前置きするパス (null で終了する文字列として) を指定します。
  • m_Registry
    • 現在のコンジットのフル Windows レジストリ パス (null で終了する文字列として) を指定します。このメンバは使用を推奨されなくなりました; コンジット コンフィグレーション エントリにアクセスするには、代わりに コンジット マネージャ API を使用します。
  • m_hKey
    • 現在のコンジットのプライマリ Windows レジストリ キーを指定します。このメンバは使用を推奨されなくなりました; コンジット コンフィグレーション エントリにアクセスするには、代わりに コンジット マネージャ API を使用します。
  • m_SyncPref
    • 現在のコンジットが HotSync マネージャに Custom ダイアログ ボックスでのユーザの選択が永久設定あるいは一時設定のどちらであるかを知らせるために eSyncPref 値を指定します。
  • m_SyncType
    • HotSync マネージャと現在のコンジット間で Custom ダイアログ ボックスに表示する選択された同期操作のタイプとそこでユーザが選択した同期操作のタイプを通信する eSyncType を定義します。HotSync マネージャが ConfigureConduit() を呼び出したとき、HotSync マネージャはコンジットに次の同期操作の設定を渡します。コンジットが返るとき、コンジットは HotSync マネージャにユーザの選択を渡します。
  • m_dwReserved
    • 将来使用するために予約されています。このメンバを NULL (0) をセットしてください。

互換性

  • 同期マネージャ バージョン: 3.0 以降
  • Palm OS バージョン: すべて

参照

ConfigureConduit()

CSyncProperties ^TOP^

目的

HotSync マネージャがコンジットの OpenConduit() エントリ ポイントを呼び出したときに現在のコンジットの同期操作のプロパティを指定します。

宣言されている場所

SyncCommon.h

Prototype

class CSyncProperties {
   public:
   eSyncTypes m_SyncType;
   char m_PathName[BIG_PATH];
   char m_LocalName[BIG_PATH];
   char m_UserName[BIG_PATH];
   char *m_RemoteName[SYNC_DB_NAMELEN];
   CDbListPtr *m_RemoteDbList;
   SInt32 m_nRemoteCount;
   UInt32 m_Creator;
   UInt16 m_CardNo;
   UInt32 m_DbType;
   UInt32 m_AppInfoSize;
   UInt32 m_SortInfoSize;
   eFirstSync m_FirstDevice;
   eConnType m_Connection;
   char m_Registry[BIG_PATH];
   HKEY m_hKey;
   UInt32 m_dwReserved;
}

データ メンバ

  • m_SyncType
    • 現在の同期タイプを eSyncTypes 値の 1 つとして指定します。同期マネージャはこのハンドヘルドの最後の HotSync 操作が現在のデスクトップとのものだったかどうかだけに基づいて eFast または eSlow 値を返します。非スキーマ データベースでは、これはコンジットが高速同期と低速同期のどちらを実行するかを決定するのに十分です。しかしながら、スキーマ データベースでは、この値は十分ではありません。この値を頼りに高速同期と低速同期のどちらを実行するかを決定する代わりに、スキーマ データベースを同期させるコンジットは SyncDbGetSyncMode()|C/C++ Sync Suite Reference601/2 を呼び出さなければなりません。スキーマ データベースを同期させているコンジットは未だこのフィールドで受け取った他の値 (eHHtoPC, ePCtoHH など) を信用しなければなりません。この点は、すべてのデータベース タイプで同様です。
  • m_PathName
    • コンジットのディレクトリ名を指定します。この値はコンジットの Directory コンフィグレーション エントリにセットされます。
  • m_LocalName
    • コンジットが同期させるデスクトップ ファイルを指定します。この値はコンジットの File コンフィグレーション エントリにセットされます。
  • m_UserName
    • 現在 HotSync 操作を実行しているユーザの HotSync ユーザ名 (null で終了する文字列) を指定します。
  • m_RemoteName
    • コンジットのクリエイタ ID と同じクリエイタ ID を持つハンドヘルド上のデータベースの名前の配列へのポインタを指定します。あなたのコンジットがハンドヘルド上の同じクリエイタ ID を持つ 32 よりも多いデータベースと結びつけられている場合、この配列の中にあるデータを信頼してはいけません; 代わりに e_RemoteDbList を使用します。「32 よりも多いデータベースをサポートするための変更」 を参照してください。
  • m_RemoteDbList
    • 現在のコンジットと同じクリエイタ ID を持つハンドヘルド データベースについての情報を保持する CDbList オブジェクトの配列へのポインタを指定します。配列の中にある相手無数は m_nRemoteCount メンバによって指定されます。
  • m_nRemoteCount
    • m_RemoteDbList 配列の中にあるエントリの数を指定します。
  • m_Creator
    • 現在のコンジットに関連付けられている クリエイタ ID を指定します。
  • m_CardNo
    • データベースが保存されているハンドヘルド上の メモリ カード のカード番号を指定します。
  • m_DbType
  • m_AppInfoSize
    • デフォルトのハンドヘルド データベースのアプリケーション情報ブロックのサイズを指定します。この値は利便性のためにこのオブジェクトの中に保存されます。
  • m_SortInfoSize
    • デフォルトのハンドヘルド データベースのソート情報ブロックのサイズを指定します。この値は利便性のためにこのオブジェクトの中に保存されます。
  • m_FirstDevice
    • 現在の HotSync 操作がこのハンドヘルドにとって最初のものであるかどうか、現在のデスクトップと最初であるかどうか、どちらにとっても最初ではないかどうかを示す eFirstSync 値を指定します。
  • m_Connection
    • 現在の HotSync 操作の転送メディアのタイプを示す eConnType を指定します。
  • m_Registry
    • 現在のコンジットのフル Windows レジストリ パス (null で終了する文字列として) を指定します。このメンバは使用を推奨されなくなりました; コンジット コンフィグレーション エントリにアクセスするには、代わりに コンジット マネージャ API を使用します。
  • m_hKey
    • 現在のコンジットのプライマリ Windows レジストリ キーを指定します。このメンバは使用を推奨されなくなりました; コンジット コンフィグレーション エントリにアクセスするには、代わりに コンジット マネージャ API を使用します。
  • m_dwReserved
    • 将来使用するために予約されています。このメンバを NULL (0) をセットしてください

コメント

コンジットは現在の HotSync プロセスの一般同期タイプとそれに関連付けられているハンドヘルド データベースを決定するためにこのクラスを使用することができます。

互換性

  • 同期マネージャ バージョン: すべて
  • Palm OS バージョン: すべて

「32 よりも多いデータベースをサポートするための変更」 を参照してください。

参照

OpenConduit()

CSystemInfo ^TOP^

目的

SyncReadSystemInfo() がハンドヘルドから取得するシステム情報を定義します。

宣言されている場所

SyncCommon.h

Prototype

class CSystemInfo {
   public:
   UInt32 m_RomSoftVersion;
   UInt32 m_LocalId;
   HSByte m_ProdIdLength;
   HSByte m_AllocedLen;
   HSByte *m_ProductIdText;
   UInt32 m_dwReserved;
}

データ メンバ

  • m_RomSoftVersion
    • HotSync 操作の最中にハンドヘルドの ROM から Palm OS バージョンを受け取ります。呼び出し元はこの値をメジャー バージョン番号とマイナー バージョン番号に出コードするために SYNCROMVMAJOR() と SYNCROMVMINOR() マクロを使用することができます。HotSync マネージャ バージョン 6.0 以降はこの値を ユーザ データ保管場所 に保存するため、HotSync 操作の最中でなくてもこの値にアクセスできるということに注意してください。
  • m_LocalId
    • ハンドヘルドのローカリゼーション ID を受け取ります。現在のところ、すべてのシステムは値 0x00010000L を返します。
  • m_ProdIdLength
    • m_ProductIdText に返されるプロダクト ID の実際の長さを受け取ります。
  • m_AllocedLen
    • 呼び出し元が m_ProductIdText バッファに割り当てたバイト数を指定します。
  • m_ProductIdText
    • ハンドヘルドからプロダクト ID を受け取りためのバイト配列を定義します。呼び出し元は SyncReadSystemInfo() を呼び出す前にこのバッファに少なくとも SYNC_MAX_PROD_ID_SIZE のサイズを割り当てなければなりません。このフィールドはハンドヘルド上のプロセッサのタイプを示します。プロセッサ タイプのリストは、Palm OS SDK の Exploring Palm OS: System Management を参照してください。
  • m_dwReserved
    • 将来使用するために予約されています。このメンバを NULL (0) をセットしてください

互換性

  • 同期マネージャ バージョン: すべて
  • Palm OS バージョン: すべて

参照

SyncReadSystemInfo()

CUserIDInfo ^TOP^

目的

SyncReadUserID() が返す現在のハンドヘルド ユーザについての情報を受け取ります。

宣言されている場所

SyncCommon.h

Prototype

class CUserIDInfo {
   public:
   char m_pName[SYNC_REMOTE_USERNAME_BUF_SIZE];
   SInt32 m_NameLength;
   char m_Password[SYNC_REMOTE_PASSWORD_BUF_SIZE];
   SInt32 m_PasswdLength;
   SInt32 m_LastSyncDate;
   UInt32 m_LastSyncPC;
   UInt32 m_Id;
   UInt32 m_ViewerId;
   UInt32 m_dwReserved;
}

データ メンバ

  • m_pName
    • ハンドヘルドのユーザ名を長さ SYNC_REMOTE_USERNAME_BUF_SIZE 以下の null 文字で終了する配列として受け取ります。この値はハンドヘルドが同期をとられたことがない場合は 0 です。
  • m_NameLength
    • m_pName メンバに返されるユーザ名の NULL 終端子を含む実際の長さ (バイト数) を受け取ります。
  • m_Password
    • ユーザのパスワードを長さ SYNC_REMOTE_PASSWORD_BUF_SIZE 以下の null 文字で終了する配列として受け取ります。パスワードはバイナリ フォーマットに暗号化されています。
  • m_PasswdLength
    • m_Password メンバに返されるユーザの暗号化されたパスワードの NULL 終端子を含む実際の長さ (バイト数) を受け取ります。
  • m_LastSyncDate
    • ハンドヘルドの最も最近の同期の日付を受け取ります。これは time_t 値です。
  • m_LastSyncPC
    • ハンドヘルドと最も最近に同期させられたデスクトップ コンピュータの PC ID を受け取ります。HotSync マネージャは HotSync マネージャがインストールされたときにこの値を生成し、それをデスクトップ コンピュータに保存します; さらに HotSync 操作の最中にそれをハンドヘルドに保存します。このメンバの中にあるこの値はハンドヘルドから読み込まれます。
  • m_Id
    • ハンドヘルドのユーザ ID を受け取ります。
  • m_ViewerId
    • ハンドヘルドの ID を受け取ります。現在使用されません。
  • m_dwReserved
    • 将来使用するために予約されています。同期マネージャ関数を呼び出す前に呼び出し元はこのメンバを NULL (0) をセットしなければなりません。

互換性

  • 同期マネージャ バージョン: すべて
  • Palm OS バージョン: すべて

参照

SyncReadUserID()

共通同期マネージャ構造体と型 ^TOP^

この節では、スキーマ、拡張、クラシック、共通同期マネージャ関数がパラメータとしてとる以下の構造体とデータ型について説明します。さらにコンジット エントリ ポイント API で使用されるいくつかの構造体とデータ型を含みます。

構造体/データ型 説明
CONDHANDLE コンジットを同期マネージャに登録、登録解除するためのハンドルを定義します。
DBDatabaseInfo データベース ヘッダの中の情報を定義します。定義されるフィールドはデータベースがスキーマ、拡張、クラシック データベースのどれであるかに依存します。

CONDHANDLE Typedef ^TOP^

目的

コンジットを同期マネージャに登録、登録解除するためのハンドルを定義します。

宣言されている場所

SyncCommon.h

Prototype

typedef UInt32 CONDHANDLE

互換性

  • 同期マネージャ バージョン: すべて
  • Palm OS バージョン: すべて

参照

SyncRegisterConduit(), SyncUnRegisterConduit()

DBDatabaseInfo 構造体 ^TOP^

目的

データベース ヘッダの中の情報を定義します。定義されるフィールドはデータベースがスキーマ、拡張、クラシック データベースのどれであるかに依存します。

宣言されている場所

SyncCommon.h

Prototype

typedef struct DBDatabaseInfo {
// Section 1: 
// Basic fields for all database types.
   UInt32 type;
   UInt32 creator;
   UInt16 attributes;
   UInt16 flags;
   UInt16 version;
   UInt32 createDate;
   UInt32 modifyDate;
   UInt32 backupDate;
   UInt32 modifyNumber;
   char name[dmDBNameLength];
// Section 2: 
// Retrieved by SyncDbFindDatabase() and 
// SyncDbFindDatabaseByTypeCreator() functions 
// for all database types.
   UInt32 rowCount;
   UInt32 totalBytes;
   UInt32 dataBytes;
// Section 3: 
// Retrieved by SyncDbReadOpenDatabaseInfo() 
// for schema databases only.
   UInt16 encoding;
   UInt32 tableCount;
   char dispName[dmDBNameLength];
// Section 4: 
// Retrieved by SyncDmReadOpenDatabaseInfo() for 
// non-schema databases only.
   UInt32 appBlkSize;
   UInt32 sortBlkSize;
   UInt32 maxRecSize;
} DBDatabaseInfo

フィールド

  • type
  • creator
  • attributes
    • データベースの属性を定義します。このフィールドは 1 つまたは複数の 「データベース属性」 の組み合わせです。
  • flags
    • このデータベースが HotSync 操作から除外さるかどうか、このデータベースがハンドヘルドの RAM の中にあるかどうかを定義します。このフィールドは 1 つまたは複数の 「データベース情報フラグ」 で説明されている値の組み合わせです。
  • version
    • アプリケーション特有のバージョン番号を定義します。開発者はこのバージョン番号をデータベースに対して定義し、Palm OS はより新しいバージョンのデータベースが古いデータベースを上書きできるかどうかを決定するためにこの値を使用することができます。デフォルトのバージョン番号は 0 です。
  • createDate
    • データベースが作成された日付を受け取ります。これは time_t 値です。下の「コメント」を参照してください。
  • modifyDate
    • データベースの最も最近の変更日付を受け取ります。これは time_t 値です。下の「コメント」を参照してください。Note: Palm OS のバージョン 1.x はこの変更日付を更新しません。
  • backupDate
    • データベースの最も最近のバックアップ日付を受け取ります。これは time_t 値です。下の「コメント」を参照してください。
  • modifyNumber
    • データベース変更番号を受け取ります。この値はデータベースの中のレコードがハンドヘルド上で追加、変更、削除されるたびに +1 されます。
  • name
    • null で終了する データベース名 を文字配列として定義します。Palm OS Cobalt はスキーマ データベースの表示名 (dispname フィールドで定義されています) が定義されている場合はそれを使用します; 表示メンが定義されていない場合は内部名 (name フィールドで定義されています) を使用します。
  • rowCount
    • スキーマ データベースの行数を受け取ります。
  • totalBytes
    • スキーマ データベースによって使用されているオーバヘッドも含めた保存領域の総バイト数を受け取ります。dataBytes フィールドとは対照をなします。
  • dataBytes
    • スキーマ データベースによって使用されているデータのみ - オーバヘッドを除く - の総バイト数を受け取ります。totalBytes フィールドとは対照をなします。
  • encoding
  • tableCount
    • スキーマ データベースの中にあるテーブルの数を定義します。
  • dispName
    • (スキーマ データベースのみ) null で終了する表示 データベース名 を文字配列として定義します。Palm OS Cobalt はデータベースの表示名が定義されている場合はそれを使用します; 表示名が定義されていない場合は内部名 (name フィールドで定義されています) を使用します。
  • appBlkSize
    • (非スキーマ データベースのみ) 拡張データベースの中のアプリケーション情報ブロックのブロック サイズ (バイト数) を受け取ります。このフィールドは SYNC_DB_INFO_OPT_GET_SIZE オプションがセットされているときに SyncDmReadOpenDatabaseInfo()|C/C++ Sync Suite Reference601/3 によってのみ情報を埋め込まれます。
  • sortBlkSize
    • (非スキーマ データベースのみ) 拡張データベースの中のソート情報ブロックのブロック サイズ (バイト数) を受け取ります。このフィールドは SYNC_DB_INFO_OPT_GET_SIZE オプションがセットされているときに SyncDmReadOpenDatabaseInfo()|C/C++ Sync Suite Reference601/3 によってのみ情報を埋め込まれます。
  • maxRecSize
    • (非スキーマ データベースのみ) 拡張データベースの中の最も大きなレコードのサイズを受け取ります。このフィールドは SYNC_DB_INFO_OPT_GET_MAX_REC_SIZE オプションがセットされているときに SyncDmReadOpenDatabaseInfo()|C/C++ Sync Suite Reference601/3 によってのみ情報を埋め込まれます。

コメント

createDate, modifyDate, backupDate はスキーマ データベースと拡張データベースでは GMT の time_t 値です; クラシック データベースでは、これらの値はハンドヘルドのローカル タイムの time_t 値です。

互換性

  • 同期マネージャ バージョン: 2.4 以降
  • Palm OS バージョン: Palm OS Cobalt, バージョン 6.0 以降

参照

SyncReadDatabaseList()|C/C++ Sync Suite Reference601/2, SyncDbFindDatabase()|C/C++ Sync Suite Reference601/2, SyncDbFindDatabaseByTypeCreator()|C/C++ Sync Suite Reference601/2, SyncDbReadOpenDatabaseInfo()|C/C++ Sync Suite Reference601/2, SyncDmFindDatabase()|C/C++ Sync Suite Reference601/3, SyncDmFindDatabaseByTypeCreator()|C/C++ Sync Suite Reference601/3, SyncDmReadOpenDatabaseInfo()|C/C++ Sync Suite Reference601/3, SyncIsDatabaseBackupNeeded(), SyncGenerateBackupFileName(), SyncReadBackupImageInfo(), SyncInstallDatabase(), SyncInstallAndBackupDatabase()

共通同期マネージャ定数 ^TOP^

この節ではスキーマ、拡張、クラシック、共通動機マネージャ関数によって使用される以下の列挙対とプロセッサ定数について説明します。

定数 説明
データベース属性 データベースが持つことのできる属性のセットを定義します。これらの属性はスキーマ、拡張、クラシック データベースに適用されます。
データベース クローズ オプション SyncDbCloseDatabase(), SyncDmCloseDatabaseEx(), SyncCloseDBEx() がデータベースをクローズするときにとるオプションのアクションを示します。
データベース情報フラグ DBDatabaseInfo 構造体の flags フィールドの値を定義します。
データベース情報取得オプション 同期マネージャの検索関数がどのようにデータベースについてのデータを取得するのかを示します。
データベース検索オプション 同期マネージャの検索関数がどのように検索操作を実行するのかを示します。
使用を推奨されなくなった定数 定数の使用を推奨されなくなったバージョン。下で定義されている新しい定数を使用してください。
eConnType ハンドヘルドがデスクトップ コンピュータとローカルで接続されているか、高速接続か、低速接続となる可能性のあるリモート接続なのかを示します。
eDbFlags データベースが持つことのできる属性のセットを定義します。
eDbOpenModes データベースをオープンするモードを示します。
eDesktopTrustStatus 進行中の HotSync 操作のデスクトップ信用状態を示します。
eFirstSync コンジットにこのハンドヘルドが前回このデスクトップ コンピュータと同期したのかどうかを示します。
eMiscDbListFlags CDbList オブジェクトの中のデータベースのその他のプロパティを示します。
eSyncPref CSyncPreference オブジェクトまたは CfgConduitInfoType 構造体の中で指定されているユーザ設定が一時適用と永久適用のどちらであるかを示します。
eSyncRecAttrs CRawRecordInfo の m_Attribs メンバの中で組み合わされるレコード変更属性を示します。
eSyncTypes HotSync マネージャからコンジットに送られる、またはコンジットの Custom ダイアログ ボックスから HotSync マネージャに送られる実行する HotSync 操作のタイプを示します。
最大バッファ サイズ いくつかの同期マネージャ関数によって使用されるさまざまなバッファの最大サイズを定義します。
その他の定数 さまざまな同期マネージャ関数で使用される定数を定義します。
レコード属性 非スキーマ データベースの中のレコードの属性を定義します。
同期マネージャ API のバージョン SyncGetAPIVersion() によって返される同期マネージャ API のメジャー バージョン番号とマイナー バージョン番号を定義します。

データベース属性 ^TOP^

目的

データベースが持つことのできる属性のセットを定義します。これらの属性はスキーマ、拡張、クラシック データベースに適用されます。

宣言されている場所

SyncCommon.h

定数

  • #define dmAllHdrAttrs ( dmHdrAttrResDB | dmHdrAttrReadOnly | dmHdrAttrAppInfoDirty | dmHdrAttrBackup | dmHdrAttrOKToInstallNewer | dmHdrAttrResetAfterInstall | dmHdrAttrCopyPrevention | dmHdrAttrStream | dmHdrAttrHidden | dmHdrAttrLaunchableData | dmHdrAttrRecyclable | dmHdrAttrBundle | dmHdrAttrSchema | dmHdrAttrSecure | dmHdrAttrFixedUp | dmHdrAttrOpen )
    • すべてのヘッダ属性を指定するために使用されるマスク。
  • #define dmHdrAttrAppInfoDirty 0x0004
    • (非スキーマ データベースのみ) アプリケーション情報ブロックは Dirty (最後の HotSync 操作の後に変更されました)。
  • #define dmHdrAttrBackup 0x0008
    • 利用可能なアプリケーション特有のコンジットが無い場合、このデータベースはデスクトップ コンピュータにバックアップされるべきです。
  • #define dmHdrAttrBundle 0x0800
    • ビーム (無線通信) の最中にこのデータベースは同じクリエイタ ID を持つアプリケーションにバンドルされます。つまり、ユーザがアプリケーションをランチャからビームすることを選択した場合、ランチャはこのデータベースをアプリケーションのリソース データベースとオーバレイ データベースと一緒にビームします。
      この属性は Palm OS バージョン 4.0 以降に適用されます。オーバレイ データベースは自動的にアプリケーション データベースとともにビームされることに注意してください。あなたはオーバレイ データベースにこのビットをセットする必要はありません。
  • #define dmHdrAttrClassic 0x0000
    • このデータベースはクラシック レコード データベースです。Palm OS だけがこの属性をセットできます。
  • #define dmHdrAttrCopyPrevention 0x0040
    • データベースが赤外線通信などによってコピーされることを防ぎます。
  • #define dmHdrAttrExtended (dmHdrAttrSecure)
    • このデータベースは拡張データベースです。この属性は dmHdrAttrSecure の値と同じ値であることに注意してください。データベースがスキーマ データベースではない場合、この属性はデータベースが拡張データベースとクラシック データベースのどちらであるかを決定します。
  • #define dmHdrAttrFixedUp 0x4000
    • Palm OS ローダはリロケーションのためにアプリケーションを修正しなければなりませんでした。Palm OS だけがこの属性をセットできます。
  • #define dmHdrAttrHidden 0x0100
    • このデータベースは閲覧から隠されているべきです。例えば、この属性はいつくかのアプリケーションをランチャのメイン ビューで隠すためにセットされます。あなたは、ランチャが Info ダイアログにデータベースの行やリソースの数を表示するときにランチャにデータベースの行やリソースを無視させるために、個の属性を非リソース データベースにセットすることができます。
  • #define dmHdrAttrLaunchableData 0x0200
    • このデータベース (実行形式ではないもの) はランチャから起動させることが可能です。ランチャは sysAppLaunchCmdOpenNamedDB アクション コードを使ってこのデータベースの名前をデータベースを所有するアプリケーション (同じクリエイタ ID を持つ 'appl' データベース) に渡します。
  • #define dmHdrAttrOKToInstallNewer 0x0010
    • バックアップ コンジットはこのデータベースがオープンされている場合にこのデータベースの新しいバージョンを異なる名前でインストールすることができます。
  • #define dmHdrAttrOpen 0x8000
    • このデータベースはオープンされています。Palm OS だけがこの属性をセットできます。
  • #define dmHdrAttrReadOnly 0x0002
    • このデータベースは Read-only データベースです。
  • #define dmHdrAttrRecyclable 0x0400
    • このデータベースはリサイクル可能です。リサイクル可能なデータベースはクローズされたときやシステム リセットがかかったときに削除されます。
  • #define dmHdrAttrResDB 0x0001
    • このデータベースはリソース データベースです。Palm OS だけがこの属性をセットできます。
  • #define dmHdrAttrResetAfterInstall 0x0020
    • このハンドヘルドはこのデータベースがインストールされた後にリセットされなければなりません。つまり、ハンドヘルド上の HotSync アプリケーションはこのデータベースのインストール後に強制的にリセットをかけます。
  • #define dmHdrAttrSchema 0x1000
    • このデータベースはスキーマ データベースです。Palm OS だけがこの属性をセットできます。
  • #define dmHdrAttrSecure 0x2000
    • このデータベースは保護されているデータベースです。この属性は dmHdrAttrExtended と同じ値を持つということに注意してください。データベースがスキーマ データベースである場合、この属性はデータベースが保護されたデータベースであるかどうかを決定します。Palm OS だけがこの属性をセットできます。
  • #define dmHdrAttrStream 0x0080
    • このデータベースはファイル ストリームです。
  • #define dmSysOnlyHdrAttrs ( dmHdrAttrResDB | dmHdrAttrSchema | dmHdrAttrSecure | dmHdrAttrFixedUp | dmHdrAttrOpen )
    • システムだけが変更できる属性を指定するマスク。

コメント

DBDatabaseInfo 構造体の中の attributes フィールドはこれらの値の有効な組み合わせのいずれかを持つことができます。

これらの属性のうちのいくつかによって指定されているデータベースのタイプについての説明は、Introduction to Conduit Development の 第 8 章 「Palm OS データベース」 を参照してください。

互換性

  • 同期マネージャ バージョン: 2.4 以降
  • Palm OS バージョン: Palm OS Cobalt, バージョン 6.0 以降

参照

DBDatabaseInfo, SyncReadDatabaseList()|C/C++ Sync Suite Reference601/2, SyncDbFindDatabase()|C/C++ Sync Suite Reference601/2, SyncDbFindDatabaseByTypeCreator()|C/C++ Sync Suite Reference601/2, SyncDbReadOpenDatabaseInfo()|C/C++ Sync Suite Reference601/2, SyncIsDatabaseBackupNeeded(), SyncGenerateBackupFileName(), SyncReadBackupImageInfo(), SyncInstallAndBackupDatabase(), SyncInstallDatabase()

データベース クローズ オプション ^TOP^

目的

SyncDbCloseDatabase()|C/C++ Sync Suite Reference601/2, SyncDmCloseDatabaseEx()|C/C++ Sync Suite Reference601/3, SyncCloseDBEx() がデータベースをクローズするときにとるオプションのアクションを示します。

宣言されている場所

SyncCommon.h

定数

  • #define SYNC_CLOSE_DB_OPT_UPDATE_BACKUP_DATE 0x80
    • データベースがクローズされた後にデータベースのバックアップ日付は更新されることを示します。
  • #define SYNC_CLOSE_DB_OPT_UPDATE_MOD_DATE 0x40
    • データベースがクローズされた後にデータベースの変更日付は更新されることを示します。

コメント

スキーマ データベースに対して、追加のクローズ オプションが 「データベース変更リセット フラグ」|C/C++ Sync Suite Reference601/2 で説明されています。これは SyncDbCloseDatabase()|C/C++ Sync Suite Reference601/2 でのみ使用されます。

互換性

参照

SyncDbCloseDatabase()|C/C++ Sync Suite Reference601/2, SyncDmCloseDatabaseEx()|C/C++ Sync Suite Reference601/3, SyncCloseDBEx()

データベース情報フラグ ^TOP^

目的

DBDatabaseInfo 構造体の flags フィールドのための値を定義します。

宣言されている場所

SyncCommon.h

定数

  • #define dbFlagExcludeFromSync ((UInt16)0x0080)
    • このデータベースは同期操作から除外されることを示します。通常、これはハンドヘルド上のこのデータベースに関連付けされているアプリケーションに対してユーザが同期を使用不可にした結果です (HotSync クライアントの Options > Conduit Setup メニュー アイテムからアクセスすることが可能です)。
  • #define dbFlagRamBased ((UInt16)0x0040)
    • このデータベースは RAM の中に置かれているということを示します。このフラグがセットされていない場合、このデータベースは ROM に保存されています。

互換性

  • 同期マネージャ バージョン: 2.4 以降
  • Palm OS バージョン: Palm OS Cobalt, バージョン 6.0 以降

参照

DBDatabaseInfo

データベース情報取得オプション ^TOP^

目的

同期マネージャの検索関数がデータベースについてのデータをどのように取得するかを示します。

宣言されている場所

SyncCommon.h

定数

  • #define SYNC_DB_INFO_OPT_GET_ATTRIBUTES (0x80)
    • データベース検索はデータベース属性情報を取得するということを示します。
  • #define SYNC_DB_INFO_OPT_GET_MAX_REC_SIZE (0x20)
  • #define SYNC_DB_INFO_OPT_GET_SIZE (0x40)
    • データベース検索はレコード (またはリソース) 数とデータ サイズ情報を取得するということを示します。

コメント

パフォーマンスを最適化するには、これらのオプションのいずれかまたはすべてを省略します。それにより、検索操作は呼び出し元が必要とする以上の情報を返さなくなります。
スキーマ データベースに対しては、追加の取得オプションが SyncDBReadOpenDatabaseInfo() に対するデータベース情報取得オプション|C/C++ Sync Suite Reference601/2 で定義されています。

互換性

  • 同期マネージャ バージョン: 2.2 以降
  • Palm OS バージョン: 3.0 以降

参照

SyncFindDbByName(), SyncFindDbByTypeCreator(), SyncReadOpenDbInfo(), SyncDatabaseInfoType, SyncFindDbByNameParams, SyncFindDbByTypeCreatorParams, SyncReadOpenDbInfoParams, SyncDbReadOpenDatabaseInfo()|C/C++ Sync Suite Reference601/2

データベース検索オプション ^TOP^

目的

同期マネージャの「検索」関数が検索操作をどのように実行するかを示します。

宣言されている場所

SyncCommon.h

定数

  • #define SYNC_DB_SRCH_OPT_NEW_SEARCH (0x80)
    • 新しい検索を開始することを示します。同じ検索を繰り返す場合、2 回目以降の検索では呼び出し元はこのフラグを外さなければなりません。
  • #define SYNC_DB_SRCH_OPT_ONLY_LATEST (0x40)
    • 検索は最新バージョンに対するものであることを示します。

互換性

  • 同期マネージャ バージョン: 2.2 以降
  • Palm OS バージョン: 3.0 以降

参照

SyncDmFindDatabaseByTypeCreator()|C/C++ Sync Suite Reference601/3, SyncFindDbByTypeCreator(), SyncFindDbByTypeCreatorParams

使用を推奨されなくなった定数 ^TOP^

目的

新しい定数が定義されたために使用を推奨されなくなった定数。以下で定義されている新しい定数を使用してください。

宣言されている場所

SyncCommon.h

定数

  • #define DB_NAMELEN SYNC_DB_NAMELEN
  • #define eExcludeFromSync eMiscDbFlagExcludeFromSync
    • 下位互換性のために定義されています。"eMiscDbListFlags" で定義されている新しい名前の定数を使用してください。
  • #define eModem eModemConnType
    • 下位互換性のために定義されています。"eConnType" で定義されている新しい名前の定数を使用してください。
  • #define PASSWORD_LENGTH SYNC_REMOTE_PASSWORD_BUF_SIZE
  • #define REMOTE_CARDNAMELEN SYNC_REMOTE_CARDNAME_BUF_SIZE
  • #define REMOTE_MANUFNAMELEN SYNC_REMOTE_MANUFNAME_BUF_SIZE
  • #define REMOTE_USERNAME SYNC_REMOTE_USERNAME_BUF_SIZE

互換性

  • 同期マネージャ バージョン: すべて
  • Palm OS バージョン: すべて

eConnType ^TOP^

目的

ハンドヘルドがデスクトップ コンピュータとローカルで接続されているか、高速接続か、低速接続となる可能性のあるリモート接続なのかを示します。

宣言されている場所

SyncCommon.h

定数

  • eCable
    • ハンドヘルドが高速接続でローカルに接続されていて、USB またはシリアル ケーブルまたはローカル エリア ネットワークを通じてのどれかで接続されていることを示します。
  • eModemConnType
    • ハンドヘルドはリモートで接続されていて、もしかすると低速接続である - 例えば、モデム経由 - ことを示します。
  • eConnTypeDoNotUse = 0xFFFF
    • すべてのコンパイラに列挙体を 4 バイトの値として見させるために使用される無効な値です。使用してはいけません。

互換性

  • 同期マネージャ バージョン: すべて
  • Palm OS バージョン: すべて

参照

CSyncProperties

eDbFlags ^TOP^

目的

データベースが持つことのできる属性のセットを定義します。

宣言されている場所

SyncCommon.h

定数

  • eRecord = 0x0000
    • データベースはレコード データベースであることを示します。この値はデフォルトの値であり、eResource とは互いに排他的です。
  • eResource = 0x0001
    • データベースはレコード データベースであることを示します。このフラグが指定されていない場合、データベースはレコード データベースであるとみなされます。たいていのコンジットはレコード データベースだけにアクセスします。
  • eReadOnly = 0x0002
    • データベースは ROM の中にある Read-only のデータベースであることを示します。
  • eAppInfoDirty = 0x0004
    • データベースのアプリケーション情報ブロックは変更されていることを示します。スキーマ データベースに対しては有効ではありません。
  • eBackupDB = 0x0008
    • データベースはデスクトップ コンピュータにバックアップされることを - 同じクリエイタ ID を持つアプリケーション特有のコンジットが登録されていない場合に - 示します。
  • eOkToInstallNewer = 0x0010
    • バックアップ/リストア コンジットは現在のバージョンのデータベースがオープンされている場合に新しいバージョンのデータベースを異なる名前でインストールできるということを示します。
  • eResetAfterInstall = 0x0020
    • HotSync の最中にデータベースがインストールされた場合、HotSync の実施後にハンドヘルドはリセットされる必要があるということを示します (実際は、データベースを伴った同期操作が完了した後に)。
  • eCopyPrevention = 0x0040
    • データベースはコピーされたり、他のハンドヘルドにビーム (無線通信) されないことを示します。コピー防止は Palm OS バージョン 3.0 以降でサポートされます。
  • eStream = 0x0080
    • データベースはファイル ストリーム実装のために使用されるということを示します。
  • eHidden = 0x0100
    • データベースは普通閲覧から隠されるべきであることを示します。例えば、このフラグはいくつかのアプリケーションをランチャのメイン ビューから隠すために使用されます。レコード データベースでは (リソース データベースではなく)、このフラグはランチャの情報フォームの中のレコード数を隠します。
  • eLaunchableData = 0x0200
    • レコード データベース (実行形式のアプリケーションではないもの) は sysAppLaunchCmdOpenNamedDB を使ってそのデータベースの名前をそのデータベースを所有するアプリケーション (同じクリエイタ ID を持つ 'appl' データベース) に渡すことによって「起動させる」ことが可能であることを示します。
  • eRecyclable = 0x0400
    • データベース (レコードまたはリソース) は「再利用可能」であることを示します - つまり、そのデータベースはまもなく - 普通、次にそのデータベースがクローズされるときに - 削除されます。
  • eBundle = 0x0800
    • データベース (レコードまたはリソース) は同じクリエイタ ID を持つアプリケーションに関連付けされているということを示します。そのデータベースはアプリケーションとともにビーム (無線通信) され、コピーされます。
      この属性は Palm OS バージョン 4.0 以降で適用されます。オーバレイ データベースは自動的にアプリケーション データベースとともにビームされるということに注意してください。あなたはこのビットをオーバレイ データベースにセットする必要はありません。
  • eSchema = 0x1000
    • データベースはスキーマ データベースであり、クラシック データベースまたは拡張データベースではないということを示します。スキーマ データベースは Palm OS Cobalt でのみサポートされます。
  • eSecure = 0x2000
    • データベースは eSchema もセットされている場合、セキュア データベースであるということを示します; eSchema がセットされていない場合は、拡張データベースであるということを示します。セキュア データベースと拡張データベースは Palm OS Cobalt でのみサポートされます。
  • eOpenDB = 0x8000
    • データベースは現在オープンされているということを示します。
Note
このフラグをデータベースを作成しているときに渡してはいけません。このフラグはシステムだけが使用します！
  • eDbFlagsDoNotUse = 0xFFFF
    • すべてのコンパイラに列挙値を 4 バイトの値として見させるために使用される無効な値です。使用してはいけません。

コメント

呼び出し元はデータベースについての情報を指定するためにこれらのフラグを組み合わせることができます。他の関数はデータベースのプロパティを示すためにこれらの値の組み合わせを返します。eRecord フラグと eResource フラグは相互に排他的であり、あなたはデータベースを作成するときにどちらか 1 つを指定しなければならないということに注意してください。

スキーマ データベースに対しては、eSchema と eRecord をセットしなくてはならず、eResource をセットしてはいけません; eSecure もセットされている場合、そのデータベースはセキュア スキーマ データベースです。

非スキーマ データベースに対しては、eSchema はセットされません。この場合、eSecure はデータベースが非スキーマ データベースのどちらのタイプであるかを示します: セットされている場合、拡張データベースです; セットされていない場合、クラシック データベースです。非スキーマ データベースに対しては、eRecord または eResource のどちらかがセットされます。

相互排他的な特性についての要約については、Introduction to Conduit Development の 「相互排他的なデータベース特性」 を参照してください。

互換性

  • 同期マネージャ バージョン: すべて
  • Palm OS バージョン: 各定数の定義を参照してください。

参照

CDbCreateDB, CDbList, SyncReadOpenDbInfoParams, SyncCreateDB(), SyncReadOpenDbInfo(), SyncDmCreateDatabase()|C/C++ Sync Suite Reference601/3, SyncFindDbByName(), SyncFindDbByTypeCreator()

eDbOpenModes ^TOP^

目的

非スキーマ データベースをオープンするモードを示します。

宣言されている場所

SyncCommon.h

定数

  • eDbShowSecret = 0x0010
    • ユーザのシークレット レコードにフル アクセスできるようデータベースをオープンすることを示します。
NOTE
現在のところ、2 つだけの同期マネージャ関数がこのモードによって影響を受けます: あなたが eDbShowSecret フラグを指定せずにデータベースをオープンした場合、SyncReadNextRecInCategory() と SyncReadNextModifiedRecInCategory() 関数はシークレット レコードをスキップします。
  • eDbExclusive = 0x0020
    • 呼び出し元に対して排他的にデータベースをオープンすることを示します。これはデータベースがすでにこのモードでオープンされている場合、呼び出し元はアクセスを拒否されるということを意味します。呼び出し元が排他的モードでデータベースをオープンすることに成功した場合、その呼び出し元がそのデータベースをクローズするまで他の呼び出し元はそれにアクセスすることはできません。
  • eDbWrite = 0x0040
    • 書き込みアクセスでデータベースをオープンすることを示します。
  • eDbRead = 0x0080
    • 読み込みアクセスでデータベースをオープンすることを示します。
  • eDbOpenModesDoNotUse = 0xFFF
    • すべてのコンパイラに列挙体を 4 バイト値として見せるために使用される無効な値です。使用してはいけません。

コメント

以下のルールがデータベース オープン モード定数をどのように使用するかを説明しています:

  • 普通は eDbShowSecret フラグを含めます: さもないと、いくつかの同期マネージャ関数はプライベートとマークを付けられているレコードを返しません。
  • Read only でデータベースをオープンするには、(eDbRead|eDbShowSecret) を指定します。
  • 読み込み/書き込みでデータベースをオープンするには、(eDbRead|eDbWrite|eDbShowSecret) を指定します。
  • 排他的モードでデータベースをオープンするには eDbExclusive を使用します。これは排他的呼び出し元がそのデータベースをクローズするまではハンドヘルド上の何者もそのデータベースをしようできないということを意味します。さらに、ハンドヘルド上の何者かがそのデータベースを使用している場合、オープンは失敗するということを意味します。

この列挙体は非スキーマ データベースをオープンする関数に対してのみ使用されるということに注意してください。スキーマ データベースをオープンするためにモードについては 「データベース オープン モード」|C/C++ Sync Suite Reference601/2 を参照してください。

互換性

  • 同期マネージャ バージョン: すべて
  • Palm OS バージョン: すべて

参照

SyncDmOpenDatabase()|C/C++ Sync Suite Reference601/3, SyncOpenDB()

eDesktopTrustStatus ^TOP^

目的

進行中の HotSync 操作のデスクトップ信用状態を示します。

宣言されている場所

SyncCommon.h

定数

  • eDesktopNotTrusted
    • ユーザはこのデスクトップがセキュア データベースをオープンすることを許可しないということを示します。
  • eDesktopTrusted
    • ユーザはこのデスクトップがセキュア データベースをオープンすることを許可するということを示します。
  • eDesktopTrustNotVerified
    • 同期マネージャはユーザがこのデスクトップがセキュア データベースをオープンすることを許可しているかどうか検証できないということを示します。

互換性

  • 同期マネージャ バージョン: 2.4 以降
  • Palm OS バージョン: Palm OS Cobalt, バージョン 6.0 以降

参照

SyncGetDesktopTrustStatus()

eFirstSync ^TOP^

目的

コンジットにこのハンドヘルドが前回このデスクトップ コンピュータ条の現在の Windows ユーザと同期したのかどうかを示します。

宣言されている場所

SyncCommon.h

定数

  • eNeither
    • このハンドヘルドは以前この Windows ユーザと同期したということを示します: このハンドヘルドの HotSync ユーザ ID はこのデスクトップ コンピュータ上の現在の Windows ユーザのための HotSync ユーザ ID の 1 つと一致します。
  • ePC
    • このハンドヘルドは以前このデスクトップ コンピュータと同期しましたが、このデスクトップ コンピュータ上の現在の Windows ユーザによって同期させられたことはないということを示します: このハンドヘルドが持つ HotSync ユーザ ID はこのデスクトップ コンピュータ上の現在の Windows ユーザのためのどの HotSync ユーザ ID とも一致しません。
  • eHH
    • このハンドヘルドは同期したことがなく、それゆえ HotSync ユーザ ID を持っていないということを示します。これはハンドヘルドが最近リセットされた、または、ユーザ プロファイル と同期をとられたということを意味するかもしれません。
  • eFirstSyncDoNotUse = 0xFFFF
    • すべてのコンパイラに列挙体を 4 バイト値として見せるために使用される無効な値です。使用してはいけません。

コメント

HotSync マネージャはコンジットの OpenConduit() エントリ ポイントを呼び出すときにこれらの値の 1 つをコンジットに渡します。コンジットは実際の同期モードを決定するためにこの値を CSyncProperties::m_SyncType (スキーマ データベースに対しては SyncDbGetSyncMode()|C/C++ Sync Suite Reference601/2) とともに使用します。

バージョン 6.0 より前の HotSync マネージャは HotSync ユーザのセットをデスクトップ コンピュータ上のすべての Windows ユーザと共有します。そのためこれらのバージョンでは、eNeither と ePC は現在の Windows ユーザに関係なく現在のデスクトップ コンピュータと同期したことがあるということを意味します。

互換性

  • 同期マネージャ バージョン: すべて
  • Palm OS バージョン: すべて

参照

CSyncProperties, OpenConduit(), SyncDbGetSyncMode()|C/C++ Sync Suite Reference601/2

eMiscDbListFlags ^TOP^

目的

CDbList オブジェクトの中のデータベースのその他のプロパティを示します。

宣言されている場所

SyncCommon.h

定数

  • eMiscDbFlagExcludeFromSync = 0x0080
    • このデータベースは同期操作から除外されるということを示します。通常、これはユーザがハンドヘルド上のデータベースに関連付けられているアプリケーションに対して同期を不可にした結果です (HotSync クライアントの Options > Conduit Setup メニュー アイテムからアクセスできます)。この機能は Palm OS バージョン 2.0 以降でサポートされます。この定数は古い定数 eExcludeFromSync を置き換えたもとです。
  • eMiscDbFlagRamBased = 0x0040
    • このデータベースは RAM の中にあるということを示します。このフラグがセットされていない場合、このデータベースは ROM の中に保存されています。このフラグは Palm OS バージョン 3.0 以降で利用可能です。
  • eMiscDbFlagsDoNotUse = 0xFFFF
    • すべてのコンパイラに列挙体を 4 バイト値として見せるために使用される無効な値です。使用してはいけません。

コメント

これらの列挙体は CDbList クラスの m_miscFlags フィールドで使用されます。DBDatabaseInfo 構造体の中の flags フィールドは 「データベース情報フラグ」 で定義されている定数を使用します。それらの定数は本質的にこれらの列挙体と同じものです。

互換性

  • 同期マネージャ バージョン: すべて
  • Palm OS バージョン: すべて

参照

CDbList

eSyncPref ^TOP^

目的

CSyncPreference オブジェクトまたは CfgConduitInfoType 構造体の中で指定されているユーザ設定が一時適用と永久適用のどちらであるかを示します。

宣言されている場所

SyncCommon.h

定数

  • eNoPreference
    • ユーザ設定が指定されていないことを示します。
  • ePermanentPreference
    • 設定は永久的なものであり、それゆえこれから先のすべての HotSync に適用されるということを示します。
  • eTemporaryPreference
    • 設定は一時的なものであり、次の HotSync にのみ適用されるということをしめします。
  • eSyncPrefDoNotUse = 0xFFFF
    • すべてのコンパイラに列挙体を 4 バイト値として見せるために使用される無効な値です。使用してはいけません。

互換性

  • 同期マネージャ バージョン: すべて
  • Palm OS バージョン: すべて

参照

CSyncPreference, CfgConduitInfoType

eSyncRecAttrs ^TOP^

目的

CRawRecordInfo の m_Attribs メンバの中で組み合わされるレコード変更属性を示します。

宣言されている場所

SyncCommon.h

定数

  • eRecAttrDeleted = 0x80
    • このレコードはハンドヘルド上で削除されたというマークを付けられているということを示します。これは古い定数 DELETE_BIT を置き換えました。
  • eRecAttrDirty = 0x40
    • このレコードは変更されたというマークを付けられているということを示します。これは古い定数 DIRTY_BIT を置き換えました。
  • eRecAttrBusy = 0x20
    • このレコードはハンドヘルド上のアプリケーションによって使用中であるということを示します。
NOTE
この属性はシステムだけが使用します。コンジットはこれを Read-only として扱わなくてはならず、レコードを書き込むときにこの属性をセットしてはいけません。
  • eRecAttrSecret = 0x10
    • このレコードはプライベートであるというマークを付けられていてユーザが望む場合にのみ表示されるべきであるということを示します。これは古い定数 PRIVATE_BIT を置き換えました。
  • eRecAttrArchived = 0x08
    • このレコードはアーカイブするようマークを付けられているということを示します。これは古い定数 ARCHIVE_BIT を置き換えました。
  • eSyncRecAttrDoNotUse = 0xFFFF
    • すべてのコンパイラに列挙体を 4 バイト値として見せるために使用される無効な値です。使用してはいけません。

コメント

これらの値は本質的に 「レコード属性」 で定義されているものと同じです。

互換性

  • 同期マネージャ バージョン: すべて
  • Palm OS バージョン: すべて

参照

CRawRecordInfo, SyncReadRecordById(), SyncReadRecordByIndex(), SyncReadNextModifiedRec(), SyncReadNextModifiedRecInCategory(), SyncReadNextRecInCategory(), SyncResetSyncFlags(), SyncWriteRec()

eSyncTypes ^TOP^

目的

HotSync マネージャからコンジットに送られる、またはコンジットの Custom ダイアログ ボックスから HotSync マネージャに送られる実行する HotSync 操作のタイプを示します。

宣言されている場所

SyncCommon.h

定数

  • Fast
    • 高速同期を意味します: 追加、アーカイブ、削除、変更されたレコードだけがハンドヘルドとデスクトップ コンピュータ間で交換されます。
NOTE
この値はこのハンドヘルドの最後の HotSync が現在のデスクトップと行われたということだけを意味します。これは非スキーマ データベースをどのように同期させるかを決定するには十分ですが、スキーマ データベースでは不十分です。下の「コメント」を参照してください。
  • eSlow
    • 低速同期を意味します: 各レコードはハンドヘルドから読み込まれ、デスクトップ コンピュータ上の (デスクトップ データ ファイルとそのバックアップ ファイルの中にある) 対応するレコードと比較されます。HotSync マネージャはハンドヘルドが前回異なるデスクトップと同期させられていた場合にこのタイプの同期を示します。下の「コメント」を参照してください。
  • eHHtoPC
    • ハンドヘルドからのレストアを意味します: デスクトップ データベースをハンドヘルドからのデータベースで上書きします。
  • ePCtoHH
    • デスクトップ コンピュータからのレストアを意味します: ハンドヘルド上のデータベースをデスクトップ コンピュータ上のデータベースで上書きします。
  • eInstall
    • HotSync のインストール フェーズの中で HotSync マネージャがコンジットの OpenConduit() エントリ ポイントを呼び出すことを意味します。これは インストール コンジット のための同期タイプです。
  • eBackup
    • HotSync のバックアップ フェーズの中で HotSync マネージャがコンジットの OpenConduit() エントリ ポイントを呼び出すことを意味します。これは バックアップ コンジット のための同期タイプです。
  • eDoNothing
    • コンジットはハンドヘルドとデスクトップ コンピュータ間でデータを交換しないことを意味します; しかしながら、コンジットはロードされ、フラグやログ メッセージをセットすることができます。
  • eProfileInstall
    • ユーザ プロファイル ダウンロードを意味します。ユーザ プロファイル はあなたがデスクトップ コンピュータ上でセットアップすることができる特別なユーザ アカウントです。このデスクトップ コンピュータはユーザ ID をアサインすることなしにデータをハンドヘルドにダウンロードします。
  • eSyncTypeDoNotUse = 0xFFFF
    • すべてのコンパイラに列挙体を 4 バイト値として見せるために使用される無効な値です。使用してはいけません。

コメント

これらの値は以下のように使用されます:

  • HotSync マネージャがコンジットの OpenConduit() エントリ ポイントを呼び出したとき、HotSync マネージャは現在の HotSync のタイプを示すために CSyncProperties オブジェクトの中にあるこれらの値の 1 つをコンジットに渡します。

    同期マネージャはこのハンドヘルドの最後の同期が現在のデスクトップとのものであったかどうかだけに基づき eFast か eSlow を返します。非スキーマ データベースでは、コンジットが高速同期と低速同期のどちらを実行するかを決定するにはこれで十分です。しかしながらスキーマ データベースでは、これでは十分ではありません。高速同期と低速同期のどちらを実行するかを決定するためにこの値を頼りにする代わりに、スキーマ データベースの同期をとるコンジットは SyncDbGetSyncMode()|C/C++ Sync Suite Reference601/2 を呼び出さなくてはなりません。それでもスキーマ データベースの同期をとるコンジットはそのコンジットが他の値 (eHHtoPC など) を受け取るためにこのフィールドに依存しなくてはなりません。それらの値はすべてのデータベース タイプで等しく有効です。
  • HotSync マネージャがコンジットの ConfigureConduit() エントリ ポイントを呼び出したとき、HotSync マネージャは次の HotSync のためにユーザの保存されている設定を示すために CSyncPreference オブジェクトの中にあるこれらの値の 1 つをコンジットに渡します。
  • HotSync マネージャがコンジットの CfgConduit() エントリ ポイントを呼び出したとき、HotSync マネージャは次の HotSync のためにユーザの保存されている設定を示すために CfgConduitInfoType 構造体の 3 つのフィールドそれぞれの中にあるこれらの値の 1 つをコンジットに渡します。
  • HotSync マネージャがコンジットの GetConduitInfo() エントリ ポイントを呼び出して infoType = eDefaultAction を渡したとき、コンジットは実行するデフォルトの HotSync 操作を示すためにこれらの値の 1 つを返します。

互換性

  • 同期マネージャ バージョン: 2.0 以降
  • Palm OS バージョン: すべて

参照

CSyncProperties, CSyncPreference, CfgConduitInfoType, GetConduitInfo()

最大バッファ サイズ ^TOP^

目的

いくつかの同期マネージャ関数によって使用されるさまざまなバッファの最大サイズを定義します。

宣言されている場所

SyncCommon.h

定数

  • #define BIG_PATH 256
    • パスと他の名前を保持するさまざまなバッファの最大サイズ (バイト数)。
  • #define SYNC_DB_NAMELEN (32)
    • ハンドヘルド データベース名の最大サイズ (null 終端文字を含む)。この定数は古い定数 DB_NAMELEN を置き換えました。
  • #define SYNC_MAX_HH_LOG_SIZE (2*1024)
    • ハンドヘルド上の HotSync ログの最大サイズ (バイト数)。
  • #define SYNC_MAX_PROD_ID_SIZE (255)
    • プロダクト ID バッファの最大バイト数。
  • #define SYNC_MAX_USERNAME_LENGTH (20)
    • ハンドヘルド上のユーザ名の最大バイト長 (null 終端文字を含みません)。
  • #define SYNC_REMOTE_CARDNAME_BUF_SIZE (32)
    • ハンドヘルド上のメモリ カードの名前のためのバッファ サイズ (バイト数)。この定数は古い定数 REMOTE_CARDNAMELEN を置き換えました。
  • #define SYNC_REMOTE_MANUFNAME_BUF_SIZE (32)
    • ハンドヘルド上のメモリ カードの製造者名のためのバッファ サイズ (バイト数)。この定数は古い定数 REMOTE_MANUFNAMELEN を置き換えました。
  • #define SYNC_REMOTE_PASSWORD_BUF_SIZE (64)
    • ハンドヘルド上のパスワードのためのバッファ サイズ (バイト数)。この定数は古い定数 PASSWORD_LENGTH を置き換えました。
  • #define SYNC_REMOTE_USERNAME_BUF_SIZE (64)
    • ハンドヘルド上のユーザ名のためのバッファ サイズ (バイト数)。この定数は古い定数 REMOTE_USERNAME を置き換えました。

互換性

  • 同期マネージャ バージョン: 2.0 以降
  • Palm OS バージョン: すべて

その他の定数 ^TOP^

目的

さまざまな同期マネージャ関数で使用される定数を定義します。

宣言されている場所

SyncCommon.h

定数

  • #define dmDBNameLength (32)
    • データベース名 (NULL 終端子を含む) の最大 ASCII バイト数。
  • #define kOffsetEndOfData (0xFFFFFFFF)
    • SyncDmWriteRecord()|C/C++ Sync Suite Reference601/3 や SyncDbWriteColumnValue()|C/C++ Sync Suite Reference601/3 のような行書き込み操作に新しいデータを既存のデータの最後に付加するよう指定します。この定数を dataOffset パラメータに渡します。この定数を使用することはデータ サイズと等しいオフセットを指定することと等価ですが、サイズが不明のときにあらかじめサイズを取得しておくための呼び出しは必要ありません。
  • #define SIZEOF_DB_DATABASE_INFO (sizeof(DBDatabaseInfo))

互換性

  • 同期マネージャ バージョン: 2.4 以降
  • Palm OS バージョン: Palm OS Cobalt, バージョン 6.0 以降

レコード属性 ^TOP^

目的

非スキーマ データベースの中のレコードの属性を定義します。

宣言されている場所

SyncCommon.h

定数

ここから

  • #define dmAllRecAttrs ( dmRec*AttrDelete | dmRecAttrDirty | dmRecAttrBusy | dmRecAttrSecret )
    • すべてのレコード属性を表すフラグの組み合わせ。この値はエラーが起きたときに属性値をチェックするのに有用です。
  • #define dmRecAttrBusy 0x20
    • ハンドヘルド上のアプリケーションによって使用中であるレコードを表します。
NOTE
この属性はシステムのみが使用します。コンジットはこれを Read-only として扱わなくてはならず、レコード書き込み時にこの属性をセットしてはいけません。
  • #define dmRecAttrDelete 0x80
    • このレコードは削除されたというマークを付けられていることを表します。
  • #define dmRecAttrDirty 0x40
    • このレコードは変更されたというマークを付けられていることを表します。
  • #define dmRecAttrSecret 0x10
    • このレコードはプライベートであるというマークを付けられていて、ユーザが望む場合にのみ表示させるべきであるということを表します。
  • #define dmSysOnlyRecAttrs ( dmRecAttrBusy )
    • システムだけが変更できる属性であるということを表すマスク。

コメント

これらの値は CRawRecordInfo.m_Attrib で使用され、拡張同期マネージャの読み込み関数 - 例えば、SyncDmReadRecordByID()|C/C++ Sync Suite Reference601/3 - の pAttributes パラメータに返されます。

互換性

  • 同期マネージャ バージョン: 2.4 以降
  • Palm OS バージョン: Palm OS Cobalt, バージョン 6.0 以降

同期マネージャ API のバージョン ^TOP^

目的

SyncGetAPIVersion() によって返される同期マネージャ API のメジャー バージョン番号とマイナー バージョン番号を定義します。

宣言されている場所

SyncCommon.h

定数

  • #define SYNCAPI_VER_MAJOR_2 2
    • メジャー バージョン番号が 2 であることを表します。
  • #define SYNCAPI_VER_MINOR_0 0
    • マイナー バージョン番号が 0 であることを表します。
  • #define SYNCAPI_VER_MINOR_1 1
    • マイナー バージョン番号が 1 であることを表します。
  • #define SYNCAPI_VER_MINOR_2 2
    • マイナー バージョン番号が 2 であることを表します。
  • #define SYNCAPI_VER_MINOR_3 3
    • マイナー バージョン番号が 3 であることを表します。
  • #define SYNCAPI_VER_MINOR_4 4
    • マイナー バージョン番号が 4 であることを表します。
  • #define SYNCAPI_VER_MINOR_5 5
    • マイナー バージョン番号が 5 であることを表します。

互換性

  • 同期マネージャ バージョン: 2.0 以降
  • Palm OS バージョン: すべて

参照

SyncGetAPIVersion(), 第 1 章 「同期マネージャ API の概要」

↑　5 章のトップへ 5 章のページ 2 へ　→

←　4 章に戻る　↑トップへ　6 章に進む　→

Copyright (C) 2002-2006 PalmwareInfo
Powered by FreeStyleWiki3.6.2 with Perl5.008009

Index


メニュー

各種掲示板

検索

キーワード

Wiki

最新

2023/12/1

2021/4/5

2020/7/7

2020/5/15

2020/1/13

2019/4/1

2018/4/18

2018/4/17

Visitor:
[Today:]
[Yesterday:]