C/C++ Sync Suite Reference601/11-2

←　10 章に戻る?　↑トップへ　12 章に進む　→

11 コンジット マネージャ API (ページ 2)

• (ページ 1)
• コンジット マネージャ構造体
  • CmConduitType
  • CmConduitType2
  • CmDiscoveryInfoType
  • CM_CREATORLIST_ITEM_TYPE
• コンジット マネージャ定数
  • コンジット情報タイプ
  • 通信ポート
  • コンジット マネージャ バージョン
  • その他の定数
• コンジット マネージャ関数
  • CmConvertCreatorIDToString
  • CmConvertStringToCreatorID
  • CmGetBackupConduit
  • CmGetComPort
  • CmGetConduitByCreator
  • CmGetConduitByIndex
  • CmGetConduitCount
  • CmGetConduitCreatorID
  • CmGetCorePath
  • CmGetCreatorArgument
  • CmGetCreatorDirectory
  • CmGetCreatorFile
  • CmGetCreatorIDList
  • CmGetCreatorInfo
  • CmGetCreatorIntegrate
  • CmGetCreatorModule
  • CmGetCreatorName
  • CmGetCreatorPriority
  • CmGetCreatorRemote
  • CmGetCreatorTitle
  • CmGetCreatorType
  • CmGetCreatorUser
  • CmGetCreatorValueDword
  • CmGetCreatorValueString
• (ページ 2)
  • CmGetDiscoveryInfoByIndex
  • CmGetHotSyncExecPath
  • CmGetLibVersion
  • CmGetNotifierDll
  • CmGetPCIdentifier
  • CmGetSystemBackupConduit
  • CmGetSystemConduitByCreator
  • CmGetSystemConduitByIndex
  • CmGetSystemConduitCount
  • CmGetSystemConduitCreatorID
  • CmGetSystemCreatorDirectory
  • CmGetSystemCreatorFile
  • CmGetSystemCreatorIDList
  • CmGetSystemCreatorName
  • CmGetSystemCreatorPriority
  • CmGetSystemCreatorRemote
  • CmGetSystemCreatorTitle
  • CmGetSystemCreatorValueDword
  • CmGetSystemCreatorValueString
  • CmGetSystemDiscoveryInfoByIndex
  • CmGetSystemHotSyncExecPath
  • CmInstallConduit
  • CmInstallConduitByStruct
  • CmInstallCreator
  • CmInstallSystemConduitByStruct
  • CmInstallSystemCreator
  • CmIsCurrentUserAdmin
  • CmRemoveConduitByCreatorID
  • CmRemoveConduitByIndex
  • CmRemoveSystemConduitByCreatorID
  • CmRemoveSystemConduitByIndex
  • CmRestoreHotSyncSettings
• (ページ 3)
  • CmSetBackupConduit
  • CmSetComPort
  • CmSetCorePath
  • CmSetCreatorArgument
  • CmSetCreatorDirectory
  • CmSetCreatorFile
  • CmSetCreatorInfo
  • CmSetCreatorIntegrate
  • CmSetCreatorModule
  • CmSetCreatorName
  • CmSetCreatorPriority
  • CmSetCreatorRemote
  • CmSetCreatorTitle
  • CmSetCreatorUser
  • CmSetCreatorValueDword
  • CmSetCreatorValueString
  • CmSetHotSyncExecPath
  • CmSetNotifierDll
  • CmSetPCIdentifier
  • CmSetSystemBackupConduit
  • CmSetSystemCreatorDirectory
  • CmSetSystemCreatorFile
  • CmSetSystemCreatorName
  • CmSetSystemCreatorPriority
  • CmSetSystemCreatorRemote
  • CmSetSystemCreatorTitle
  • CmSetSystemCreatorValueDword
  • CmSetSystemCreatorValueString
  • FmDisableCurrentUserConduitByIndex
  • FmDisableCurrentUserConduitByPath
  • FmDisableSystemConduitByIndex
  • FmDisableSystemConduitByPath
  • FmEnableCurrentUserConduitByPath
  • FmEnableSystemConduitByPath
  • FmGetCurrentUserConduitByIndex
  • FmGetCurrentUserConduitCount
  • FmGetCurrentUserConduitFolder
  • FmGetCurrentUserDisabledConduitFolder
  • FmGetSystemConduitByIndex
  • FmGetSystemConduitCount
  • FmGetSystemConduitFolder
  • FmGetSystemDisabledConduitFolder
• コンジット マネージャ エラー コード

←　11 章のページ 1 へ　↑　11 章のトップへ　11 章のページ 3 へ　→

CmGetDiscoveryInfoByIndex 関数 ^TOP^

目的

HotSync マネージャがどのようにユーザ登録コンジットを見つけ出すのかについての情報を取得します。

宣言されている場所

CondMgr.h

Prototype

int CmGetDiscoveryInfoByIndex (
   int iIndex,
   CmDiscoveryInfoType &sDiscoveryInfo
)

パラメータ

• → iIndex
  • 現在の Windows ユーザのために登録されているコンジットの 0 ベース インデックス。インデックスの最大値を決定するには CmGetConduitCount() を呼び出します。
• ← sDiscoveryInfo
  • HotSync マネージャが指定されたコンジットを発見できたかどうか、発見できた場合はそのコンジットが Conduits フォルダの中にあるのかそれともコンジット コンフィグレーション エントリの中にあるのかを説明する CmDiscoverInfoType 構造体への参照。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_INDEX_OUT_OF_RANGE
  • 指定されたインデックス値は範囲外です。

コメント

CmDiscoverInfoType 構造体の bLoadable フィールドが FALSE である場合、指定されたコンジットは適切に登録されておらず HotSync マネージャはそれを呼び出すことができないということに注意してください。

この関数は現在の Windows ユーザのために登録されているコンジットについての情報を取得します。システムのために登録されているコンジットに対してこの情報 (訳者: HotSync マネージャがどのようにコンジットを見つけ出すかという情報) を取得するには、CmGetSystemDiscoverInfoByIndex() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

CmDiscoveryInfoType, CmGetSystemDiscoveryInfoByIndex()

CmGetHotSyncExecPath 関数 ^TOP^

目的

(使用を推奨されなくなりました) デスクトップ コンピュータ上の HotSync マネージャ実行ファイルのパスとファイル名を取得します。(サポート DLL のパスを取得するには HotSync.exe ファイル名を取り除きます。)

宣言されている場所

CondMgr.h

Prototype

int CmGetHotSyncExecPath (
   TCHAR *pPath,
   int *piSize
)

パラメータ

• ← pPath
  • 文字バッファへのポインタ。返り時には、これは HotSync マネージャ実行ファイルのパスとファイル名 - 例えば、C:\Program Files\PalmSource\Desktop\HotSync.exe - になります。HotSync マネージャがインストールされていない場合、このパラメータは空の文字列を指します。
• ←→ piSize
  • pPath パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_REGISTRY_ACCESS
• ERR_BUFFER_TOO_SMALL
  • あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
• ERR_INVALID_POINTER

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

CDK 6.0 では、この関数は使用を推奨されなくなりました。しかしながら、この関数はそれまでのコンジット インストーラとの互換性を保つために未だ利用可能です。他のすべてのコンジット インストーラはこの関数の代わりにコンジット マネージャ バージョン 3 以降で利用可能な CmGetSystemHotSyncExecPath() を使用すべきです。この値 (訳者: Arguments) を使用する HotSync マネージャのバージョンはありません。

互換性

• コンジット マネージャ バージョン: 2 以降
• Palm OS バージョン: すべて

参照

CmGetCorePath(), CmGetSystemHotSyncExecPath()

CmGetLibVersion 関数 ^TOP^

目的

現在ロードされている DLL からコンジット マネージャ API のバージョン番号を返します。

宣言されている場所

CondMgr.h

Prototype

WORD CmGetLibVersion ()

パラメータ

ありません。

返り値

「コンジット マネージャ バージョン」 で定義されている CM_UPDATE... 定数の 1 つを返します。

コメント

この章の「互換性」部分では、それぞれの関数、構造体、定数はどのバージョンのコンジット マネージャ API で使用可能なのかが示されています。例えば、「コンジット マネージャ バージョン: 2 以降」というのは、CmGetLibVersion() が 0x0002 以上の値を返す場合にその API 要素は使用可能であるということを示しています。

互換性

• コンジット マネージャ バージョン: 2 以降
• Palm OS バージョン: すべて

CmGetNotifierDll 関数 ^TOP^

目的

(使用を推奨されなくなりました) 通知機能 DLL の名前を取得します。

宣言されている場所

CondMgr.h

Prototype

int CmGetNotifierDll (
   int iIndex,
   TCHAR *pNotifier,
   int *piSize
)

パラメータ

• → iIndex
  • あなたが取得しようとしている通知機能の整数インデックス。
• ← pNotifier
  • 文字バッファへのポインタ。返り時には、これは通知機能 DLL の名前になります。
• ←→ piSize
  • pNotifier パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_REGISTRY_ACCESS
• ERR_BUFFER_TOO_SMALL
  • あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
• ERR_VALUE_NOT_FOUND
• ERR_INVALID_POINTER

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

この関数はコンフィグレーション エントリの HotSync マネージャ部分の中に値として保存されている通知機能 DLL の名前を取得します。最初の通知機能コンフィグレーション エントリは Notifier0 という名前を付けられていて、2 番目のエントリには Notifier1 という名前が付けられています。

重要

この関数は使用を推奨されなくなりました。この関数の代わりに通知機能インストール マネージャ関数の 1 つを使用してください (第 13 章 「通知機能インストール マネージャ API」 を参照してください)。CmGetNotifierDLL() は下位互換性のために残されています。しかしながら、通知機能インストール マネージャはあなたがより容易に通知機能をインストール、アンインストール、変更することを可能にします。

互換性

• コンジット マネージャ バージョン: 2 以降
• Palm OS バージョン: すべて

参照

NmGetByIndex() や他の 「通知機能インストール マネージャ API」

CmGetPCIdentifier 関数 ^TOP^

目的

デスクトップ コンピュータ上の現在の Windows ユーザの固有識別子を取得します。

宣言されている場所

CondMgr.h

Prototype

int CmGetPCIdentifier (
   DWORD *pdwPCID
)

パラメータ

• → pdwPCID
  • DWORD 値へのポインタ。返り時には、これは PC 固有識別子になります。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_REGISTRY_ACCESS
• ERR_INVALID_POINTER

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

この関数は現在の Windows ユーザのための HotSync Manager\PCIdentifier コンフィグレーション エントリの値を取得します。HotSync マネージャは HotSync マネージャを実行する各 Windows ユーザに対して異なる PC ID を生成します。同じ Windows ログインを使用している各 HotSync ユーザは同じ PC ID を持ちます。

互換性

• コンジット マネージャ バージョン: 2 以降
• Palm OS バージョン: すべて

参照

HotSync Manager\PCIdentifier, CmSetPCIdentifier()

CmGetSystemBackupConduit 関数 ^TOP^

目的

システムのためのバックアップ コンジットとして登録されているコンジットの名前を取得します。

宣言されている場所

CondMgr.h

Prototype

int CmGetSystemBackupConduit (
   TCHAR *pConduit,
   int *piSize
)

パラメータ

• ← pConduit
  • 文字バッファへのポインタ。返り時には、これはデスクトップ コンピュータ上にあるシステム バックアップ コンジットとして使用されるコンジットの名前を保持しています。
• ←→ piSize
  • pConduit パラメータによって参照される文字バッファのサイズを指定する整数へのポインタ。返り時には、これはバックアップ コンジット名文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_REGISTRY_ACCESS
• ERR_BUFFER_TOO_SMALL
  • あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
• ERR_INVALID_POINTER
• ERR_UNABLE_TO_SET_CONDUIT_VALUE

すべてのコンジット マネージャ エラー コードについての説明は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

この関数はシステムのためのに HotSync マネージャによって使用される HotSync Manager\BackupConduit コンフィグレーション エントリの値を取得します。現在の Windows ユーザのために登録されているバックアップ コンジットに対してこの情報 (訳者: バックアップ コンジットの名前) を取得するには、CmGetBackupConduit() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

HotSync Manager\BackupConduit, CmGetBackupConduit(), CmSetSystemBackupConduit()

CmGetSystemConduitByCreator 関数 ^TOP^

目的

与えられたコンジットのクリエイタ ID からシステムのために登録されているコンジットについての情報を取得します。

宣言されている場所

CondMgr.h

Prototype

int CmGetSystemConduitByCreator (
   const char *pCreatorID,
   CmConduitType2 &sConduitInfo
)

パラメータ

• → pCreatorID
  • コンジットのクリエイタ ID。文字列で与えます。
• ← sConduitInfo
  • 指定されたコンジットについて説明する CmConduitType2 構造体への参照。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_NO_CONDUIT
• ERR_NO_MEMORY
• ERR_REGISTRY_ACCESS
• ERR_INVALID_HANDLE
• ERR_INVALID_CREATOR_ID

すべてのコンジット マネージャ エラー コードについての説明は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

この関数はシステムのために登録されているコンジットについての情報を取得します。現在の Windows ユーザのために登録されているコンジットに対してこの情報 (訳者: CmConduitType2 構造体) を取得するには、CmGetConduitByCreator() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

CmConduitType2, CmInstallSystemConduitByStruct(), CmGetSystemConduitByIndex()

CmGetSystemConduitByIndex 関数 ^TOP^

目的

与えられたコンジットのインデックスからシステムのために登録されているコンジットについての情報を取得します。

宣言されている場所

CondMgr.h

Prototype

int CmGetSystemConduitByIndex (
   int iIndex,
   CmConduitType2 &sConduitInfo
)

パラメータ

• → iIndex
  • システムのために登録されているコンジットの 0 ベースのインデックス。インデックスの最大値を決定するには CmGetSystemConduitCount() を呼び出します。
• ←
  • 指定されたコンジットについて説明する CmConduitType2 への参照。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値を返します:

• ERR_INDEX_OUT_OF_RANGE

コメント

この関数はシステムのために登録されているコンジットについての情報を取得します。現在の Windows ユーザのために登録されているコンジットに対してこの情報 (訳者: CmConduitType2 構造体) を取得するには、CmGetConduitByIndex() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

CmConduitType2, CmInstallSystemConduitByStruct(), CmGetSystemConduitCount(), CmGetConduitByIndex(), CmGetSystemConduitByCreator()

CmGetSystemConduitCount 関数 ^TOP^

目的

システムのために HotSync マネージャに登録されているコンジットの数を返します。

宣言されている場所

CondMgr.h

Prototype

int CmGetSystemConduitCount (
   void
)

パラメータ

ありません。

返り値

成功した場合、登録されているコンジットの数を返します。

失敗した場合、以下の非 0 のエラー コード値を返します:

• ERR_REGISTRY_ACCESS

すべてのコンジット マネージャ エラー コードについての説明は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

返されるコンジット数に含まれるのはシステムのために登録されているすべてのコンジットです。このコンジット数にはシステムの Conduits フォルダに置かれることによって登録されたコンジット (フォルダ登録) とコンフィグレーション エントリによって登録されたコンジット (通常通りの登録) が含まれます。この数はバックアップ コンジットやインストール コンジットを含まず、現在の Windows ユーザのために登録されているコンジットも含みません。現在の Windows ユーザのために登録されているコンジットに対してこの情報 (訳者: コンジット数) を取得するには、CmGetConduitCount() を呼び出します。

あなたは CmGetSystemConduitByIndex() で使用することができる有効なインデックス値の範囲を決定するためにこの数を使用することができます。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

CmGetConduitCount(), CmGetSystemConduitByIndex()

CmGetSystemConduitCreatorID 関数 ^TOP^

目的

システムのために登録されているコンジットのクリエイタ ID を取得します。

宣言されている場所

CondMgr.h

Prototype

int CmGetSystemConduitCreatorID (
   int iIndex,
   char *pCreatorID,
   int *piSize
)

パラメータ

• → iIndex
  • システムのために登録されているコンジットの 0 ベースのインデックス。インデックスの最大値を決定するには CmGetSystemConduitCount() を呼び出します。
• ← pCreatorID
  • 文字バッファ。返り時には、これはクリエイタ ID 文字列を保持しています。
• ←→ piSize
  • pCreatorID パラメータによって参照されるバッファのサイズ (char の数) を指定する整数へのポインタ。返り時には、これはクリエイタ ID 文字列の実際のサイズ (char の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_REGISTRY_ACCESS
• ERR_BUFFER_TOO_SMALL
  • あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。

すべてのコンジット マネージャ エラー コードについての説明は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

コンフィグレーション エントリの中で定義されている最初のコンジットを指定するには 0 を使用し、その後に続くコンジットに対しては +1 していきます。

この関数はシステムのために登録されているコンジットについての情報を取得します。現在の Windows ユーザのために登録されているコンジットに対してこの情報 (訳者: クリエイタ ID) を取得するには、CmGetConduitCreatorID() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

CmGetSystemConduitCount(), CmGetConduitCreatorID(), CmInstallSystemConduitByStruct()

CmGetSystemCreatorDirectory 関数 ^TOP^

目的

システム登録コンジットがそのコンジットのユーザ データを保存するディレクトリの名前を取得します。

宣言されている場所

CondMgr.h

Prototype

int CmGetSystemCreatorDirectory (
   const char *pCreatorID,
   TCHAR *pDirectory,
   int *piSize
)

パラメータ

• → pCreatorID
  • コンジットのクリエイタ ID。あなたはこのコンジットの Directory 値を取得しようとしています。
• ← pDirectory
  • 文字列バッファへのポインタ。返り時には、これは指定されたコンジットの Directory コンフィグレーション エントリの値になります。
• ←→ piSize
  • pDirectory パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは Directory 文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_AMBIGUOUS_CREATORID
• ERR_NO_CONDUIT
• ERR_REGISTRY_ACCESS
• ERR_BUFFER_TOO_SMALL
  • あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
• ERR_VALUE_NOT_FOUND
• ERR_INVALID_CREATOR_ID
• ERR_INVALID_POINTER

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

この関数は指定されたコンジットの Directory コンフィグレーション エントリの値を取得します。ディレクトリ文字列は現在の HotSync ユーザのディレクトリ下にあるディレクトリ - これはコンジットがそのコンジットのユーザ データとサポート ファイルを保存するために作成します - を指定します。例えば、Directory の値が DateBook であり、Core\Path の値が通常の値である場合、このコンジットのデータ ディレクトリへのフル パスは以下のようになります:

C:\Documents and Settings\<WinUsername>\My Documents
\Palm OS Desktop\<HotSyncUsername>\DateBook

この関数はシステムのために登録されているコンジットについての情報を取得します。現在の Windows ユーザのために登録されているコンジットに対してこの情報 (訳者: ユーザ データを保存するディレクトリ名) を取得するには、CmGetCreatorDirectory() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

Directory, CmSetSystemCreatorDirectory(), CmGetCreatorDirectory()

CmGetSystemCreatorFile 関数 ^TOP^

目的

システム登録コンジットのためのデータ ファイルの名前を取得します。

宣言されている場所

CondMgr.h

Prototype

int CmGetSystemCreatorFile (
   const char *pCreatorID,
   TCHAR *pFile,
   int *piSize
)

• → pCreatorID
  • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの File 値を取得しようとしています。
• ← pFile
  • 文字バッファへのポインタ。返り時には、これは File コンフィグレーション エントリの値を保持しています。
• ←→ piSize
  • pFile パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは File 文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_AMBIGUOUS_CREATORID
• ERR_NO_CONDUIT
• ERR_REGISTRY_ACCESS
• ERR_BUFFER_TOO_SMALL
  • あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
• ERR_VALUE_NOT_FOUND
• ERR_INVALID_CREATOR_ID
• ERR_INVALID_POINTER

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

この関数は指定されたコンジットの File コンフィグレーション エントリの値を取得します。ファイル文字列はハンドヘルド データベースと同期されるデスクトップ ファイルの名前を指定します。このファイルの位置はどこにでもなり得ますが、通例では CmGetSystemCreatorDirectory() によって返されるディレクトリの中になります。
この関数はシステムのために登録されているコンジットについての情報を取得します。現在の Windows ユーザのために登録されているコンジットに対してこの情報 (システム登録コンジットのためのデータ ファイルの名前) を取得するには、CmGetCreatorFile() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

File|Introduction to Conduit Development601/A}, CmGetCreatorFile()

CmGetSystemCreatorIDList 関数 ^TOP^

目的

システムのために登録されているすべてのコンジットのクリエイタ ID のリストを取得します。

宣言されている場所

CondMgr.h

Prototype

int CmGetSystemCreatorIDList (
   CM_CREATORLIST_TYPE pCreatorList,
   int *piSize
)

パラメータ

• → pCreatorList
  • クリエイタ ID を保持している CM_CREATORLIST_ITEM_TYPE 構造体の配列へのポインタ。
• ←→ piSize
  • pCreatorList パラメータによって参照される配列の中にあるエントリの数を指定する整数へのポインタ。返り時には、これは配列の中にあるアイテムの実際の数になります。配列が小さすぎるためにこの関数が失敗した場合、返り時の piSize の値は必要とされる配列アイテム数になります。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_REGISTRY_ACCESS
• ERR_BUFFER_TOO_SMALL
  • あなたが提供した配列のサイズはクリエイタ ID アイテムを保持するには小さすぎます。そのため、この関数は必要とされるアイテム数を piSize パラメータに返します。

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

この関数はタイプ CM_CREATORLIST_ITEM_TYPE の構造体の配列への CM_CREATORLIST_TYPE ポインタ経由でクリエイタ ID のリストを返します。

この関数は現在の Windows ユーザのために登録されているコンジットについての情報を取得します。システムのために登録されているコンジットに対するこの情報 (訳者: コンジットのクリエイタ ID のリスト) を取得するには、この関数の代わりに CmGetSystemCreatorIDList() を呼び出します。

この関数はシステムのために登録されているコンジットについての情報を取得します。現在の Windows ユーザのために登録されているコンジットに対してこの情報 (訳者: コンジットのクリエイタ ID のリスト) を取得するには、CmGetCreatorIDList() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

CM_CREATORLIST_ITEM_TYPE, CmGetCreatorIDList(), CmInstallSystemConduitByStruct()

CmGetSystemCreatorName 関数 ^TOP^

目的

システム登録コンジットのファイル名を取得します。

宣言されている場所

CondMgr.h

Prototype

int CmGetSystemCreatorName (
   const char *pCreatorID,
   TCHAR *pConduitName,
   int *piSize
)

パラメータ

• → pCreatorID
  • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Conduit 値を取得しようとしています。
• ← pConduitName
  • 文字バッファへのポインタ。返り時には、これは指定されたコンジットの Conduit コンフィグレーション エントリの値になります。
• ←→ piSize
  • pConduit パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは Conduit 文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_AMBIGUOUS_CREATORID
• ERR_NO_CONDUIT
• ERR_REGISTRY_ACCESS
• ERR_BUFFER_TOO_SMALL
  • あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
• ERR_INVALID_CREATOR_ID
• ERR_INVALID_POINTER

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

この関数は指定されたコンジットの Conduit コンフィグレーション エントリの値を取得します。この値は指定されたクリエイタ ID で登録されているコンジット DLL のファイル名です - 例えば、ToDoCond.dll はクリエイタ ID 'todo' で登録されています。

この関数はシステムのために登録されているコンジットについての情報を取得します。現在の Windows ユーザのために登録されているコンジットに対してこの情報 (訳者: コンジットのファイル名) を取得するには、CmGetCreatorName() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

Conduit, CmSetSystemCreatorName(), CmGetCreatorName()

CmGetSystemCreatorPriority 関数 ^TOP^

目的

システム登録コンジットの実行優先順位を取得します。

宣言されている場所

CondMgr.h

Prototype

int CmGetSystemCreatorPriority (
   const char *pCreatorID,
   DWORD *pdwPriority
)

パラメータ

• → pCreatorID
  • コンジットのクリエイタ ID。あなたはこのコンジットの Priority 値を取得しようとしています。
• ← pdwPriority
  • DWORD 値へのポインタ。返り時には、これは指定されたコンジットの Priority コンフィグレーション エントリの値になります。これは 0 から 4 までの値です。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_AMBIGUOUS_CREATORID
• ERR_NO_CONDUIT
• ERR_REGISTRY_ACCESS
• ERR_INVALID_CREATOR_ID
• ERR_INVALID_POINTER
• ERR_VALUE_NOT_FOUND

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

この関数は指定されたコンジットの Priority コンフィグレーション エントリの値を取得します。HotSync マネージャはコンジットを実行する順番 - つまり、HotSync マネージャがコンジットの OpenCondui() エントリ ポイントを呼び出す順番 - を決定するために優先順位値を使用します。HotSync マネージャは 0 の値を持つコンジットを最初に実行し、4 の値を持つコンジットを最後に実行します。

この関数はシステムのために登録されているコンジットについての情報を取得します。現在の Windows ユーザのために登録されているコンジットに対してこの情報 (訳者: コンジット実行優先順位) を取得するには、CmGetCreatorPriority() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

Priority, CmSetSystemCreatorPriority(), CmGetCreatorPriority()

CmGetSystemCreatorRemote 関数 ^TOP^

目的

システム登録コンジットに関連付けされているハンドヘルド上のデータベースの名前を取得します。

宣言されている場所

CondMgr.h

Prototype

int CmGetSystemCreatorRemote (
   const char *pCreatorID,
   TCHAR *pRemoteDB,
   int *piSize
)

パラメータ

• → pCreatorID
  • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Remote 値を取得しようとしています。
• ← pRemoteDB
  • 文字バッファへのポインタ。返り時には、これは指定されたコンジットの Remote コンフィグレーション エントリの値になります。
• ←→ piSize
  • pRemoteDB パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは Remote 文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_AMBIGUOUS_CREATORID
• ERR_NO_CONDUIT
• ERR_REGISTRY_ACCESS
• ERR_BUFFER_TOO_SMALL
  • あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
• ERR_VALUE_NOT_FOUND
• ERR_INVALID_CREATOR_ID
• ERR_INVALID_POINTER

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

この関数は指定されたコンジットの Remote コンフィグレーション エントリの値を取得します。この値はこのコンジットに関連付けされているハンドヘルド上の単一のデータベースに名前をつけます。

NOTE

コンジットはハンドヘルド上の複数のデータベースにアクセスできますが、CmGetCreatorRemote() はハンドヘルド データベース名を 1 つだけ返します: このコンジットのための Remote コンフィグレーション エントリの中で指定されている (1 つの) 名前です。あなたがこのコンフィグレーション エントリを使うかどうかを決定する手助けとして、"Remote" の説明を参照してください。

この関数はシステムのために登録されているコンジットについての情報を取得します。現在の Windows ユーザのために登録されているコンジットに対してこの情報 (訳者: このシステム登録コンジットに関連付けされているハンドヘルド状のデータベース名) を取得するには、CmGetCreatorRemote() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

Remote, CmSetSystemCreatorRemote(), CmGetCreatorRemote()

CmGetSystemCreatorTitle 関数 ^TOP^

目的

システム登録コンジットの表示名を取得します。

宣言されている場所

CondMgr.h

Prototype

int CmGetSystemCreatorTitle (
   const char *pCreatorID,
   TCHAR *pTitle,
   int *piSize
)

パラメータ

• → pCreatorID
  • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Name 値を取得しようとしています。
• ← pTitle
  • 文字バッファへのポインタ。返り時には、これは指定されたコンジットの Name コンフィグレーション エントリの値になります。
• ←→ piSize
  • pTitle パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは Name 文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_AMBIGUOUS_CREATORID
• ERR_NO_CONDUIT
• ERR_REGISTRY_ACCESS
• ERR_BUFFER_TOO_SMALL
  • あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
• ERR_VALUE_NOT_FOUND
• ERR_INVALID_CREATOR_ID
• ERR_INVALID_POINTER

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

この関数は指定されたコンジットの Name コンフィグレーション エントリの値を取得します。この値が NULL ではない場合、HotSync マネージャはそれを Custom ダイアログ ボックスと HotSync Progress ダイアログ ボックスでコンジットの表示名として使用します。この値が NULL である場合、HotSync マネージャはコンジットの GetConduitInfo() エントリ ポイントによって返される値を使用し、それが失敗した場合はコンジットの GetConduitName() エントリ ポイントを使用します。

この関数はシステムのために登録されているコンジットについての情報を取得します。現在の Windows ユーザのために登録されているコンジットに対するこの情報 (訳者: コンジットの表示名) を取得するには、この関数の代わりに CmGetCreatorTitle() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

Name, CmSetSystemCreatorTitle(), CmGetCreatorTitle()

CmGetSystemCreatorValueDword 関数 ^TOP^

目的

システム登録コンジットのための DWORD コンフィグレーション エントリ値を取得します。

宣言されている場所

CondMgr.h

Prototype

int CmGetSystemCreatorValueDword (
   const char *pCreatorID,
   TCHAR *pValue,
   DWORD *dwValue,
   DWORD dwDefault
)

パラメータ

• → pCreatorID
  • コンジットのクリエイタ ID 文字列。あなたはこのコンジットのコンフィグレーション エントリ値を取得しようとしています。
• → pValue
  • コンフィグレーション エントリ名。
• ← dwValue
  • 返り時には、これは pValue によって指定されたコンフィグレーション エントリの値を保持しています。
• → dwDefault
  • 指定された pValue 値がコンフィグレーション エントリの中で見つからなかった場合に dwValue に返されるデフォルトの値。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_AMBIGUOUS_CREATORID
• ERR_NO_CONDUIT
• ERR_REGISTRY_ACCESS
• ERR_INVALID_CREATOR_ID
• ERR_INVALID_POINTER
• ERR_VALUE_NOT_FOUND

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

この関数はコンジットのコンフィグレーション エントリから DWORD 値を取得します。この関数は名前によってコンジット コンフィグレーション エントリ値を取得する汎用関数です。あなたはあなた自身が使用するために CmSetSystemCreatorValueDword() で作成したコンフィグレーション エントリの値を取得するためにこの関数を使用できます。

コンジット マネージャが pValue で指定されたコンフィグレーション エントリ名を見つけられなかった場合、この関数は dwValue を dwDefault の値に等しくして 0 (成功) を返します。しかしながら、pCreatorID で指定されたコンジットが存在しない場合、この関数は dwValue を dwDefault に等しくすることはせず、エラーを返します。

この関数はシステムのために登録されているコンジットについての情報を取得します。現在の Windows ユーザのために登録されているコンジットに対するこの情報 (訳者: コンコンフィグレーション エントリ) を取得するには、この関数の代わりに CmGetCreatorValueDword() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

CmSetSystemCreatorValueDword(), CmGetCreatorValueDword(), CmGetSystemCreatorValueString()

CmGetSystemCreatorValueString 関数 ^TOP^

目的

システム登録コンジットのための文字列コンフィグレーション エントリ値を取得します。

宣言されている場所

CondMgr.h

Prototype

int CmGetSystemCreatorValueString (
   const char *pCreatorID,
   TCHAR *pValue,
   TCHAR *pString,
   int *piSize,
   TCHAR *pDefault
)

パラメータ

• → pCreatorID
  • コンジットのクリエイタ ID 文字列。あなたはこのコンジットのコンフィグレーション エントリ値を取得しようとしています。
• → pValue
  • コンフィグレーション エントリ名。
• ← pString
  • 文字バッファへのポインタ。返り時には、これは pValue によって指定されたコンフィグレーション エントリの値になっています。
• ←→ piSize
  • pString パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。
• → pDefault
  • 指定された pValue 名がコンフィグレーション エントリの中に見つからなかった場合に pString に返されるデフォルトの値。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_AMBIGUOUS_CREATORID
• ERR_NO_CONDUIT
• ERR_REGISTRY_ACCESS
• ERR_BUFFER_TOO_SMALL
  • あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
• ERR_INVALID_CREATOR_ID
• ERR_INVALID_POINTER

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

この関数はコンジットのコンフィグレーション エントリから文字列値を取得します。この関数は名前によってコンジット コンフィグレーション エントリ値を取得する汎用関数です。あなたはあなた自身が使用するために CmSetSystemCreatorValueString() で作成したコンフィグレーション エントリの値を取得するためにこの関数を使用できます。

コンジット マネージャが pValue で指定されたコンフィグレーション エントリ名を見つけられなかった場合、この関数はデフォルト値を戻して (pString を pDefault の値に等しくして)、0 (成功) を返します。しかしながら、pCreatorID で指定されたコンジットが存在しない場合、この関数はデフォルト値を戻さず、エラーを返します。

この関数はシステムのために登録されているコンジットについての情報を取得します。現在の Windows ユーザのために登録されているコンジットに対するこの情報 (訳者: コンコンフィグレーション エントリ) を取得するには、この関数の代わりに CmGetCreatorValueString() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

CmSetSystemCreatorValueString(), CmGetCreatorValueString(), CmGetSystemCreatorValueDword()

CmGetSystemDiscoveryInfoByIndex 関数 ^TOP^

目的

HotSync マネージャがシステム登録コンジットを発見する方法を取得します。

宣言されている場所

CondMgr.h

Prototype

int CmGetSystemDiscoveryInfoByIndex (
   int iIndex,
   CmDiscoveryInfoType &sDiscoveryInfo
)

パラメータ

• → iIndex
  • 現在の Windows ユーザのために登録されているコンジットの 0 ベース インデックス。インデックスの最大値を決定するには CmGetSystemConduitCount() を呼び出します。
• ← sDiscoveryInfo
  • HotSync マネージャが指定されたコンジットを発見できたかどうか、発見できた場合はそのコンジットが Conduits フォルダの中にあるのかそれともコンジット コンフィグレーション エントリの中にあるのかを説明する CmDiscoverInfoType 構造体への参照。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_INDEX_OUT_OF_RANGE
  • 指定されたインデックス値は範囲外です。

コメント

CmDiscoverInfoType 構造体の bLoadable フィールドが FALSE である場合、指定されたコンジットは適切に登録されておらず HotSync マネージャはそれを呼び出すことができないということに注意してください。

この関数はシステムのために登録されているコンジットについての情報を取得します。現在の Windows ユーザのために登録されているコンジットに対してこの情報 (訳者: HotSync マネージャがどのようにコンジットを見つけ出すかという情報) を取得するには、CmGetDiscoverInfoByIndex() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

CmDiscoveryInfoType, CmGetDiscoveryInfoByIndex()

CmGetSystemHotSyncExecPath 関数 ^TOP^

目的

デスクトップ コンピュータ上の HotSync マネージャ実行ファイルのパスとファイル名を取得します。（サポート DLL のパスを取得するには HotSync.exe ファイル名を取り除きます。）

宣言されている場所

CondMgr.h

Prototype

int CmGetSystemHotSyncExecPath (
   TCHAR *pPath,
   int *piSize
)

パラメータ

• ← pPath
  • 文字バッファへのポインタ。返り時に、これは HotSync マネージャ実行ファイルのパスとファイル名になります - 例えば、C:\Program Files\PalmSource\Desktop\HotSync.exe です。
• ←→ piSize
  • pPath パラメータによって参照されるバッファ - TCHAR 配列 - のサイズを示す整数へのポインタ。返り時に、これは文字列 - TCHAR 配列 - の実際のサイズになります。文字列バッファが小さすぎてこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。

返り値

成功時には 0 を返します。

不成功時には以下の非 0 のエラー コード値の 1 つを返します:

• ERR_REGISTRY_ACCESS
• ERR_BUFFER_TOO_SMALL
  • あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのためこの関数は必要とされるサイズを piSize パラメータに戻します。
• ERR_INVALID_POINTER

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

この関数は HotSync マネージャの Core\HotSyncPath コンフィグレーション エントリの値を取得します。この値はデスクトップ コンピュータ上の HotSync 実行形式ファイルのパスとファイル名です。HotSync マネージャがインストールされていない場合、pPath パラメータは空の文字列を指します。

NOTE

CondMgr.dll のようなサポート DLL のパスを調べるには、この関数を呼び出して、pPath によって指される文字列バッファの最後尾からファイル名 HotSync.exe を取り除きます。

HotSync マネージャのバージョンが 6 よりも前

HotSync マネージャのバージョンが 6 以降

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

CmGetCorePath(), CmGetHotSyncExecPath()

CmInstallConduit 関数 ^TOP^

目的

コンジットを現在の Windows ユーザのために HotSync マネージャに登録します。CmConduitType 構造体を使用します。

宣言されている場所

CondMgr.h

Prototype

int CmInstallConduit (
   HANDLE hStruct
)

パラメータ

• → hStruct
  • インストールするコンジットのハンドル。これは CmConduitType 構造体へのハンドルです。

返り値

成功した場合、0 を返します。

不成功時には以下の非 0 のエラー コード値の 1 つを返します:

• ERR_CONDUIT_MGR
• ERR_NO_CONDUIT
• ERR_NO_MEMORY
• ERR_CREATORID_ALREADY_IN_USE
• ERR_REGISTRY_ACCESS
• ERR_UNABLE_TO_CREATE_CONDUIT
• ERR_UNABLE_TO_SET_CONDUIT_VALUE
• ERR_INVALID_HANDLE
• ERR_INVALID_CREATOR_ID

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

コンジットを登録するには、CmConduitType 構造体のフィールドに情報を埋め込み、構造体へのハンドルをこの関数に渡します。

NOTE

PalmSource はこの関数の代わりに CmInstallConduitByStruct() や CmInstallSystemConduitByStruct() を使用することを推奨します。これらの関数は CmInstallConduit() とは異なりメモリ管理を必要としません。単一の構造体を用いて通常通りの方法でコンジットを登録することについての更なる情報は、C/C++ Sync Suite Companion の 「単一の構造体を作成する」 を参照してください。

この関数は現在の Windows ユーザのためにコンジットを登録します。システムのためにコンジットを登録するには、CmInstallSystemConduitByStruct() や CmInstallSystemCreator() を呼び出します。

互換性

• コンジット マネージャ バージョン: 2 以降
• Palm OS バージョン: すべて

参照

CmConduitType, CmInstallConduitByStruct(), CmInstallCreator(), CmInstallSystemConduitByStruct(), CmInstallSystemCreator()

CmInstallConduitByStruct 関数 ^TOP^

目的

コンジットを現在の Windows ユーザのために HotSync マネージャに登録します。CmConduitType2 構造体を使用します。

宣言されている場所

CondMgr.h

Prototype

int CmInstallConduitByStruct (
   CmConduitType2 &sConduitInfo
)

パラメータ

• → sConduitInfo
  • コンジット登録情報を指定する CmConduitType2 構造体への参照。

返り値

成功時には 0 を返します。

不成功時には以下の非 0 のエラー コード値の 1 つを返します:

• ERR_CONDUIT_MGR
• ERR_NO_CONDUIT
• ERR_NO_MEMORY
• ERR_CREATORID_ALREADY_IN_USE
• ERR_REGISTRY_ACCESS
• ERR_UNABLE_TO_CREATE_CONDUIT
• ERR_UNABLE_TO_SET_CONDUIT_VALUE
• ERR_INVALID_CREATOR_ID

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

コンジットを登録するには、CmConduitType2 構造体のフィールドに情報を埋め込み、その構造体への参照をこの関数に渡します。単一の構造体で通常通りにコンジットを登録する方法についての更なる情報は、C/C++ Sync Suite Companion の 「単一の構造体を作成する」 を参照してください。

この関数はコンジットを現在の Windows ユーザのために登録します。システムのためにコンジットを登録するには、CmInstallSystemConduitByStruct() または CmInstallSystemCreator() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

CmConduitType2, CmInstallCreator(), CmInstallSystemConduitByStruct(), CmInstallSystemCreator()

CmInstallCreator 関数 ^TOP^

目的

新しいコンジット クリエイタ ID を現在の Windows ユーザのために HotSync マネージャに登録します (登録を完了するには CmSetCreator...() 関数を呼び出すことが必要です)。

宣言されている場所

CondMgr.h

Prototype

int CmInstallCreator (
   const char *pCreator,
   int iType
)

パラメータ

• → pCreator
  • コンジットのクリエイタ ID 文字列。これは Creator コンフィグレーション エントリをセットします。
• → iType
  • コンジット タイプ。これは {{ Conduit Information Types,「コンジット情報タイプ」|C/C++ Sync Suite Reference601/11-1}} で説明されている値の 1 つです。ほとんどすべてのコンジットに対して、CONDUIT_APPLICATION 値を指定します。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_CREATORID_ALREADY_IN_USE
• ERR_REGISTRY_ACCESS
• ERR_UNABLE_TO_CREATE_CONDUIT
• ERR_UNABLE_TO_SET_CONDUIT_VALUE
• ERR_INVALID_CREATOR_ID
• ERR_INVALID_CREATOR_TYPE

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

この関数はコンジット コンフィグレーション エントリの新しいセットの Creator 値を作成、セットします。コンジットを登録するためにこの関数を使用するには、あなたはまずこの関数を呼び出さなければなりません; それからこの関数呼び出しが成功した場合はコンジットの残りのコンフィグレーション エントリを指定するために他の CmSetCreator...() 関数を呼び出します。

HotSync マネージャはあなたが iType パラメータに渡した値を区別することはありません。しかしながら、あなたは値を渡さなければなりません。その値はほとんどすべてのコンジットに対して CONDUIT_APPLICATION になります。

この関数はまだ現在の Windows ユーザのために登録されていないコンジットのクリエイタ ID をセットします。システムのためにまだ登録されていないコンジットのクリエイタ ID をセットするには、CmInstallSystemCreator() や CmInstallSystemConduitByStruct() を呼び出します。

互換性

• コンジット マネージャ バージョン: 2 以降
• Palm OS バージョン: すべて

参照

Creator, CmInstallConduitByStruct(), CmInstallSystemCreator(), CmInstallSystemConduitByStruct()

CmInstallSystemConduitByStruct 関数 ^TOP^

目的

コンジットをシステムのために HotSync マネージャに登録します。CmConduitType2 構造体を使用します。

宣言されている場所

CondMgr.h

Prototype

int CmInstallSystemConduitByStruct (
   const CmConduitType2 &sConduitInfo
)

パラメータ

• → sConduitInfo
  • コンジット登録情報を指定する CmConduitType2 構造体への参照。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_CONDUIT_MGR
• ERR_NO_CONDUIT
• ERR_NO_MEMORY
• ERR_CREATORID_ALREADY_IN_USE
• ERR_REGISTRY_ACCESS
• ERR_UNABLE_TO_CREATE_CONDUIT
• ERR_UNABLE_TO_SET_CONDUIT_VALUE
• ERR_INVALID_CREATOR_ID
• ERR_INSUFFICIENT_PRIVILEGES

現在の Windows ユーザはこの操作を実行するのに十分な権限を持っていません。管理者権限が必要です。

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

コンジットを登録するには、CmConduitType2 構造体のフィールドに情報を埋め込み、その構造体への参照をこの関数に渡します。単一の構造体を用いて通常通りの方法でコンジットを登録することについての更なる情報は、C/C++ Sync Suite Companion の 「単一の構造体を作成する」 を参照してください。

この関数はシステムのためにコンジットを登録します。現在の Windows ユーザのためにコンジットを登録するには、CmInstallConduitByStruct() や CmInstallConduit() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

CmConduitType2, CmInstallSystemCreator(), CmInstallConduitByStruct(), CmInstallCreator()

CmInstallSystemCreator 関数 ^TOP^

目的

新しいコンジット クリエイタ ID を現在のシステムのために HotSync マネージャに登録します (登録を完了するには CmSetSystemCreator...() 関数を呼び出すことが必要です)。

宣言されている場所

CondMgr.h

Prototype

int CmInstallSystemCreator (
   const char *pCreator,
   int iType
)

パラメータ

• → pCreator
  • コンジットのクリエイタ ID 文字列。これは Creator コンフィグレーション エントリをセットします。
• → iType
  • コンジット タイプ。これは {{ Conduit Information Types,「コンジット情報タイプ」|C/C++ Sync Suite Reference601/11-1}} で説明されている値の 1 つです。ほとんどすべてのコンジットに対して、CONDUIT_APPLICATION 値を指定します。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_CREATORID_ALREADY_IN_USE
• ERR_REGISTRY_ACCESS
• ERR_UNABLE_TO_CREATE_CONDUIT
• ERR_UNABLE_TO_SET_CONDUIT_VALUE
• ERR_INVALID_CREATOR_ID
• ERR_INVALID_CREATOR_TYPE
• ERR_INSUFFICIENT_PRIVILEGES

現在の Windows ユーザはこの操作を実行するのに十分な権限を持っていません。管理者権限が必要です。

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

この関数はコンジット コンフィグレーション エントリの新しいセットの Creator 値を作成、セットします。コンジットを登録するためにこの関数を使用するには、あなたはまずこの関数を呼び出さなければなりません; それからこの関数呼び出しが成功した場合はコンジットの残りのコンフィグレーション エントリを指定するために他の CmSetSystemCreator...() 関数を呼び出します。

HotSync マネージャはあなたが iType パラメータに渡した値を区別することはありません。しかしながら、あなたは値を渡さなければなりません。その値はほとんどすべてのコンジットに対して CONDUIT_APPLICATION になります。

この関数はまだシステムのために登録されていないコンジットのクリエイタ ID をセットします。現在の Windows ユーザのためにまだ登録されていないコンジットのクリエイタ ID をセットするには、CmInstallCreator() や CmInstallConduitByStruct() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

Creator, CmInstallSystemConduitByStruct(), CmInstallCreator(), CmInstallConduitByStruct()

CmIsCurrentUserAdmin 関数 ^TOP^

目的

現在のユーザが Windows 管理者権限を持っているかどうかを決定します。

宣言されている場所

CondMgr.h

Prototype

BOOL CmIsCurrentUserAdmin ()

パラメータ

ありません。

返り値

現在のユーザが管理者権限を持っている場合、TRUE を返します。

持っていない場合、FALSE を返します。

コメント

システムのためにコンフィグレーション エントリをセットするすべてのコンジット マネージャ関数 (CmSet...System...() 関数や他の関数) は、現在の Windows ユーザが管理者権限を持っていない場合、ERR_INSUFFICIENT_PRIVILEGES エラーを返します。しかしながら、それは NTFS ファイル システムである場合にのみです。あなたがこれらの関数を呼び出す前にこれらの関数が失敗するかどうかを決定するには、関数呼び出しに先立って CmIsCurrentUserAdmin() を呼び出します。管理者権限を持っていないユーザであっても、コンジット マネージャ関数はシステム レベル情報を読み込むことはできます。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

CmRemoveConduitByCreatorID 関数 ^TOP^

目的

与えられたコンジットのクリエイタ ID によって現在の Windows ユーザのために登録されているコンジットの登録を解除します。

宣言されている場所

CondMgr.h

Prototype

int CmRemoveConduitByCreatorID (

  const char *pCreatorID

)

パラメータ

• → pCreatorID
  • コンジットのクリエイタ ID 文字列。

返り値

成功した場合、削除されたコンジットの数を返します。この値は常に 1 です。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_FOLDER_NOT_FOUND
  • 指定されたフォルダ登録コンジットを使用不可にすることができません。なぜなら、Disabled フォルダが存在せず、作成することもできないためです。
• ERR_UNABLE_TO_DELETE
• ERR_NO_CONDUIT
• ERR_REGISTRY_ACCESS
• ERR_INVALID_CREATOR_ID

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

クリエイタ ID を与えられるとこの関数はコンジットの登録を解除します。コンジットが通常通りの方法で登録されていた - 例えば、CmInstallConduitByStruct() を使って - 場合、この関数はそのコンジットのすべてのコンフィグレーション エントリを削除します。しかしながら、コンジットが現在の Windows ユーザの Conduits フォルダに置かれていた場合、この関数はそのコンジットを Disabled フォルダに移動させます。そのためフォルダ登録コンジットに対してこの関数を呼び出すことは FmDisableCurrentUserConduitByPat() を呼び出すのと同じ結果となります。

この関数は現在の Windows ユーザのためのコンジットの登録を解除します。システムのためのコンジットの登録を解除するには、CmRemoveSystemConduitByCreatorID() または CmRemoveSystemConduitByIndex() を呼び出します。

互換性

• コンジット マネージャ バージョン: 2 以降
• Palm OS バージョン: すべて

参照

CmRemoveConduitByIndex(), CmRemoveSystemConduitByCreatorID(), CmRemoveSystemConduitByIndex()

CmRemoveConduitByIndex 関数 ^TOP^

目的

与えられたコンジットのインデックスによって現在の Windows ユーザのために登録されているコンジットの登録を解除します。

宣言されている場所

CondMgr.h

Prototype

int CmRemoveConduitByIndex (
   int iIndex
)

パラメータ

• → iIndex
  • 現在の Windows ユーザのために登録されているコンジットの 0 ベース インデックス。インデックスの最大値を決定するには CmGetConduitCount() を呼び出します。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_FOLDER_NOT_FOUND
  • 指定されたフォルダ登録コンジットを使用不可にすることはできません。なぜなら、Disabled フォルダが存在せず、作成することもできないためです。
• ERR_INDEX_OUT_OF_RANGE
• ERR_UNABLE_TO_DELETE
• ERR_REGISTRY_ACCESS

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

0 ベース インデックスが与えられるとこの関数はコンジットの登録を解除します。コンジットが通常通りの方法で登録されていた - 例えば、CmInstallConduitByStruct() を用いて - 場合、この関数はそのコンジットのすべてのコンフィグレーション エントリを削除します。しかしながら、コンジットが現在の Windows ユーザの Conduits フォルダに置かれていた場合、この関数はそのコンジットを Disabled フォルダに移動させます。そのためフォルダ登録コンジットに対してこの関数を呼び出すことは FmDisableCurrentUserConduitByPat() を呼び出すのと同じ結果となります。

この関数は現在の Windows ユーザのためのコンジットの登録を解除します。システムのためのコンジットの登録を解除するには、CmRemoveSystemConduitByCreatorID() または CmRemoveSystemConduitByIndex() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

CmRemoveConduitByCreatorID(), CmRemoveSystemConduitByIndex(), CmRemoveSystemConduitByCreatorID()

CmRemoveSystemConduitByCreatorID 関数 ^TOP^

目的

与えられたコンジットのクリエイタ ID によってシステムのために登録されているコンジットの登録を解除します。

宣言されている場所

CondMgr.h

Prototype

int CmRemoveSystemConduitByCreatorID (
   const char *pCreatorID
)

パラメータ

• → pCreatorID
  • コンジットのクリエイタ ID 文字列。

返り値

成功した場合、削除されたコンジットの数を返します。この値は常に 1 です。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_FOLDER_NOT_FOUND
  • 指定されたフォルダ登録コンジットを使用不可にすることができません。なぜなら、Disabled フォルダが存在せず、作成することもできないためです。
• ERR_UNABLE_TO_DELETE
• ERR_NO_CONDUIT
• ERR_REGISTRY_ACCESS
• ERR_INVALID_CREATOR_ID
• ERR_INSUFFICIENT_PRIVILEGES
  • 現在の Windows ユーザはこの操作を実行するのに十分な権限を持っていません。管理者権限が必要です。

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

クリエイタ ID を与えられるとこの関数はコンジットの登録を解除します。コンジットが通常通りの方法で登録されていた - 例えば、CmInstallSystemConduitByStruct() を使って - 場合、この関数はそのコンジットのすべてのコンフィグレーション エントリを削除します。しかしながら、コンジットがシステムの Conduits フォルダに置かれていた場合、この関数はそのコンジットをシステム Disabled フォルダに移動させます。そのためフォルダ登録コンジットに対してこの関数を呼び出すことは FmDisableSystemConduitByPat() を呼び出すのと同じ結果となります。

この関数はシステムのためのコンジットの登録を解除します。現在の Windows ユーザのためのコンジットの登録を解除するには、CmRemoveConduitByCreatorID() または CmRemoveConduitByIndex() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

CmRemoveSystemConduitByIndex(), CmRemoveConduitByCreatorID(), CmRemoveConduitByIndex()

CmRemoveSystemConduitByIndex 関数 ^TOP^

目的

与えられたコンジットのインデックスによってシステムのために登録されているコンジットの登録を解除します。

宣言されている場所

CondMgr.h

Prototype

int CmRemoveSystemConduitByIndex (
   int iIndex
)

パラメータ

• → iIndex
  • システムのために登録されているコンジットの 0 ベース インデックス。インデックスの最大値を決定するには CmGetSystemConduitCount() を呼び出します。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_FOLDER_NOT_FOUND
  • 指定されたフォルダ登録コンジットを使用不可にすることができません。なぜなら、Disabled フォルダが存在せず、作成することもできないためです。
• ERR_UNABLE_TO_DELETE
• ERR_NO_CONDUIT
• ERR_REGISTRY_ACCESS
• ERR_INVALID_CREATOR_ID
• ERR_INSUFFICIENT_PRIVILEGES
  • 現在の Windows ユーザはこの操作を実行するのに十分な権限を持っていません。管理者権限が必要です。

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

0 ベース インデックスを与えられるとこの関数はコンジットの登録を解除します。コンジットが通常通りの方法で登録されていた - 例えば、CmInstallSystemConduitByStruct() を使って - 場合、この関数はそのコンジットのすべてのコンフィグレーション エントリを削除します。しかしながら、コンジットがシステムの Conduits フォルダに置かれていた場合、この関数はそのコンジットをシステム Disabled フォルダに移動させます。そのためフォルダ登録コンジットに対してこの関数を呼び出すことは FmDisableSystemConduitByPat() を呼び出すのと同じ結果となります。

この関数はシステムのためのコンジットの登録を解除します。現在の Windows ユーザのためのコンジットの登録を解除するには、CmRemoveConduitByCreatorID() または CmRemoveConduitByIndex() を呼び出します。

互換性

• コンジット マネージャ バージョン: 3 以降
• Palm OS バージョン: すべて

参照

CmRemoveSystemConduitByCreatorID(), CmRemoveConduitByIndex(), CmRemoveConduitByCreatorID()

CmRestoreHotSyncSettings 関数 ^TOP^

目的

(使用を推奨されなくなりました) HotSync マネージャ コンフィグレーション エントリ設定をデフォルト値に戻します。

宣言されている場所

CondMgr.h

Prototype

int CmRestoreHotSyncSettings (
   BOOL bToDefaults
)

パラメータ

• → bToDefaults
  • TRUE である場合、エントリを削除してデフォルトの設定を用いてエントリを再度追加します。FALSE である場合、すでに上書きされている設定以外のエントリをデフォルト値に戻します。

返り値

成功した場合、0 を返します。

失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:

• ERR_FOLDER_NOT_FOUND
  • Conduits または Disabled フォルダが存在せず、作成することもできません。
• ERR_INSUFFICIENT_PRIVILEGES
  • 現在の Windows ユーザはこの操作を実行するのに十分な権限を持っていません。管理者権限が必要です。

エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。

コメント

CDK 6.0 では、この関数は使用を推奨されなくなり、将来のコンジット マネージャ API のバージョンでは旧式化します。

WARNING!

• この関数を使用してはいけません。この関数を呼び出すといくつかのサード パーティ コンジットは正しく動作しなくなる可能性があります。

この関数は HotSync マネージャのための Core\HotSyncPath と Core\Path コンフィグレーション エントリをデフォルト値に戻します。さらに、デフォルト コンジット (アドレス帳コンジット、予定表コンジット、To Do コンジット、メモ帳コンジット、バックアップ コンジット、インストール コンジット) と通知機能のためのコンフィグレーション エントリをリストアします。

bToDefaults パラメータが TRUE である場合、この関数はまずそれらの設定を削除し、デフォルト値を用いてそれらを再度追加します。これはデフォルト コンジットと他の設定はリストアされるが、他のコンジットのコンフィグレーション エントリは変更されないということを意味します。bToDefaults が FALSE である場合、この関数はそれらの設定をデフォルト値にリセットしますが、サード パーティの設定により上書きされているコンフィグレーション エントリは変更されません。例えば、サード パーティ コンジットがクリエイタ ID 'date' で登録されている場合、bToDefaults = TRUE でこの関数を呼び出すとコンジットのコンフィグレーション エントリは上書きされますが、bToDefaults = FALSE でこの関数を呼び出すと上書きされません。

互換性

• コンジット マネージャ バージョン: 2 以降
• Palm OS バージョン: すべて

←　11 章のページ 1 へ　↑　11 章のトップへ　11 章のページ 3 へ　→

←　10 章に戻る?　↑トップへ　12 章に進む　→