Palm Programmer's Laboratory

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

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

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

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

← 11 章のページ 2 へ ↑ 11 章のトップへ

CmSetBackupConduit 関数 ^TOP^

目的

現在の Windows ユーザのためのバックアップ コンジットのパスまたはファイル名をセットします。

宣言されている場所

CondMgr.h

Prototype

int CmSetBackupConduit (
   const TCHAR *pConduit
)

パラメータ

  • → pConduit
    • バックアップ コンジットとして使用されるコンジットのフル パスまたはファイル名。

返り値

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

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

  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_POINTER

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

コメント

この関数はコンフィグレーション エントリの中にある HotSync マネージャによって使用される Manager\BackupConduit エントリの値を確定します。あなたがファイル名を指定して、コンジット マネージャがそのファイルを見つけられない場合 (またはファイル名が NULL である場合)、この関数はファイル名を変更せずにエラーを返しません。この関数を呼び出す前に、あなたはコンジット マネージャが見つけられる場所にファイルが存在していることをチェックしなければなりません。

この関数は現在の Windows ユーザのためのバックアップ コンジットをセットします。システムのためのバックアップ コンジットをセットするには、CmSetSystemBackupConduit() を呼び出します。

互換性

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

参照

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

CmSetComPort 関数 ^TOP^

目的

HotSync マネージャがデスクトップ コンピュータの指定されたタイプの接続のために使用する COM ポートの名前をセットします。

宣言されている場所

CondMgr.h

Prototype

int CmSetComPort (
   int iType,
   const TCHAR *pPort
)

パラメータ

  • → iType
    • 接続のタイプのためにセットする COM ポート。あなたは 「通信ポート」 の中で説明されている値の 1 つを指定しなければなりません。
  • → pPort
    • ポート名を指定する文字バッファへのポインタ - 例えば、"COM1"。

返り値

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

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

  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_POINTER
  • ERR_INVALID_COM_PORT_TYPE

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

コメント

この関数は、あなたが iType パラメータに指定した値に基づいて、コンフィグレーション エントリの中の HotSync マネージャ部分にある HotSync Maneger\ModemComport または HotSync Manager\DirectComPort エントリのどちらかをセットします。これらの値は現在の Windows ユーザのためのセットであるということに注意してください。これらの値に相当するシステム専用の設定はありません。HotSync マネージャは新しい Windows ユーザに対してそれぞれデフォルト値をセットします。

互換性

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

参照

HotSync Manager\ModemComPort, HotSync Manager\DirectComPort, CmGetComPort()

CmSetCorePath 関数 ^TOP^

目的

(使用を推奨されなくなりました) 現在の Windows ユーザのための HotSync ユーザ ディレクトリのパスをセットします。

宣言されている場所

CondMgr.h

Prototype

int CmSetCorePath (
   const TCHAR *pPath
)

パラメータ

  • → pPath
    • パスを保持している文字バッファへのポインタ。

返り値

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

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

  • ERR_COULD_NOT_CREATE_DIRECTORY
    • 指定されたディレクトリを作成することはできませんでした。
  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_POINTER

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

コメント

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

WARNING!
この関数を使用してはいけません。このパスを変更すると、コンジットはそのコンジットのデスクトップ データ ファイルを見つけることができなくなります。このパスを取得するには CmGetCorePath() を使用します。しかしながらこのパスを変更してはいけません。

この関数は現在の Windows ユーザのための Core\Path コンフィグレーション エントリの値をセットします。このパスは Windows ユーザごとに異なるため、「システム レベル」のパスとは関係がありません。

互換性

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

参照

CmGetCorePath(), CmGetHotSyncExecPath()

CmSetCreatorArgument 関数 ^TOP^

目的

(使用を推奨されなくなりました) 指定されたコンジットのための Arguments コンフィグレーション エントリの値をセットします。

宣言されている場所

CondMgr.h

Prototype

int CmSetCreatorArgument (
   const char *pCreatorID,
   const TCHAR *pArgument
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Arguments コンフィグレーション エントリをセットしようとしています。
  • → pArgument
    • あなたが指定されたコンジットの Arguments コンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されたものであるため、登録情報は Read-only です。

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

コメント

CDK 6.0 では、この関数は使用を推奨されなくなりました。どの HotSync マネージャ バージョンもこの値を使用しません。

互換性

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

参照

Arguments, CmGetCreatorArgument()

CmSetCreatorDirectory 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int CmSetCreatorDirectory (
   const char *pCreatorID,
   const TCHAR *pDirectory
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Directory 値をセットしようとしています。
  • → pDirectory
    • あなたが指定されたコンジットの Directory コンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されたものであるため、登録情報は Read-only です。

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

コメント

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

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

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

互換性

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

参照

Directory, CmGetCreatorDirectory(), CmSetSystemCreatorDirectory()

CmSetCreatorFile 関数 ^TOP^

目的

ユーザ登録コンジットのためのデータ ファイルの名前をセットします。

宣言されている場所

CondMgr.h

Prototype

int CmSetCreatorFile (
   const char *pCreatorID,
   const TCHAR *pFile
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの File 値をセットしようとしています。
  • → pFile
    • あなたが指定されたコンジットの File コンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されています。そのため、このコンジットの登録情報は Read-only です。

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

コメント

この関数は指定されたコンジットの File コンフィグレーション エントリの値をセットします。ファイル文字列はハンドヘルド データベースと同期されるデスクトップ ファイルの名前を指定します。このファイルはどこにでも置くことができますが、一般には CmGetCreatorDirectory() によって返されるディレクトリの中に置きます。

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

互換性

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

参照

File, CmGetCreatorFile(), CmSetSystemCreatorFile()

CmSetCreatorInfo 関数 ^TOP^

目的

(使用を推奨されなくなりました) ユーザ登録コンジットに関連付けされる文字列をセットします。

宣言されている場所

CondMgr.h

Prototype

int CmSetCreatorInfo (
   const char *pCreatorID,
   const TCHAR *pInfo
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Information 値をセットしようとしています。
  • → pInformation
    • あなたが指定されたコンジットの Information コンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されています。そのため、このコンジットの登録情報は Read-only です。

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

コメント

CDK 6.0 では、この関数は使用を推奨されなくなりました。どの HotSync マネージャ バージョンもこの値を使用しません。

互換性

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

参照

Information, CmGetCreatorInfo()

CmSetCreatorIntegrate 関数 ^TOP^

目的

(使用を推奨されなくなりました) 指定されたコンジットのための Integrate コンフィグレーション エントリの値をセットします。

宣言されている場所

CondMgr.h

Prototype

int CmSetCreatorIntegrate (
   const char *pCreatorID,
   DWORD dwIntegrate
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Integrate 値をセットしようとしています。
  • → dwIntegrate
    • あなたが指定されたコンジットの Integrate コンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されています。そのため、このコンジットの登録情報は Read-only です。

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

コメント

CDK 6.0 では、この関数は使用を推奨されなくなりました。どの HotSync マネージャ バージョンもこの値を使用しません。

互換性

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

参照

Integrate, CmGetCreatorIntegrate()

CmSetCreatorModule 関数 ^TOP^

目的

(使用を推奨されなくなりました) 指定されたコンジットのための Module コンフィグレーション エントリの値をセットします。

宣言されている場所

CondMgr.h

Prototype

int CmSetCreatorModule (
   const char *pCreatorID,
   DWORD pModule
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Module 値をセットしようとしています。
  • → pModule
    • あなたが指定されたコンジットの Module コンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されています。そのため、このコンジットの登録情報は Read-only です。

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

コメント

CDK 6.0 では、この関数は使用を推奨されなくなりました。どの HotSync マネージャ バージョンもこの値を使用しません。

互換性

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

参照

Module, CmGetCreatorModule()

CmSetCreatorName 関数 ^TOP^

目的

ユーザ登録コンジットのファイル名をセットします。

宣言されている場所

CondMgr.h

Prototype

int CmSetCreatorName (
   const char *pCreatorID,
   const TCHAR *pConduitName
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID。あなたはこのコンジットの Conduit をセットしようとしています。
  • → pConduitName
    • あなたが指定されたコンジットの Conduit コンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されています。そのため、このコンジットの登録情報は Read-only です。

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

コメント

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

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

互換性

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

参照

Conduit, CmGetCreatorName(), CmSetSystemCreatorName()

CmSetCreatorPriority 関数 ^TOP^

目的

ユーザ登録コンジットのための実行優先順位をセットします。

宣言されている場所

CondMgr.h

Prototype

int CmSetCreatorPriority (
   const char *pCreatorID,
   DWORD dwPriority
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID。あなたはこのコンジットの Priority をセットしようとしています。
  • → dwPriority
    • あなたが指定されたコンジットの Priority コンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されています。そのため、このコンジットの登録情報は Read-only です。

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

コメント

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

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

互換性

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

参照

Priority, CmGetCreatorPriority(), CmSetSystemCreatorPriority()

CmSetCreatorRemote 関数 ^TOP^

目的

ユーザ登録コンジットに関連付けされるハンドヘルド上のデータベースの名前をセットします。

宣言されている場所

CondMgr.h

Prototype

int CmSetCreatorRemote (
   const char *pCreatorID,
   const TCHAR *pRemoteDB
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID。あなたはこのコンジットの Remote をセットしようとしています。
  • → pRemoteDB
    • あなたが指定されたコンジットの Remote コンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されています。そのため、このコンジットの登録情報は Read-only です。

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

コメント

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

NOTE
コンジットはハンドヘルド上の複数のデータベースにアクセスすることができます。しかしながら、CmSetCreatorRemote() が指定するのはただ 1 つのデータベース名であり、それはこのコンジットの Remote コンフィグレーション エントリに保存されます。"Remote" の説明があなたがこのコンフィグレーション エントリを使用すべきかどうかを決定するのを助けてくれます。

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

互換性

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

参照

Remote, CmGetCreatorRemote(), CmSetSystemCreatorRemote()

CmSetCreatorTitle 関数 ^TOP^

目的

ユーザ登録コンジットの表示名をセットします。

宣言されている場所

CondMgr.h

Prototype

Prototype 
int CmSetCreatorTitle (
   const char *pCreatorID,
   const TCHAR *pTitle
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Name 値をセットしようとしています。
  • → pTitle
    • あなたが指定されたコンジットの Name コンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されています。そのため、このコンジットの登録情報は Read-only です。

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

コメント

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

この関数は現在の Windows ユーザのために登録されているコンジットの情報をセットします。システムのために登録されているコンジットの表示名をセットするには、CmSetSystemCreatorTitle() を呼び出します。

互換性

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

参照

Name, CmGetCreatorTitle(), CmSetSystemCreatorTitle()

CmSetCreatorUser 関数 ^TOP^

目的

(使用を推奨されなくなりました) 指定されたコンジットのための Username コンフィグレーション エントリの値をセットします。

宣言されている場所

CondMgr.h

Prototype

int CmSetCreatorUser (
   const char *pCreatorID,
   const TCHAR *pUsername
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Name 値をセットしようとしています。
  • → pUsername
    • あなたが指定されたコンジットの Username コンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されています。そのため、このコンジットの登録情報は Read-only です。

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

コメント

CDK 6.0 では、この関数は使用を推奨されなくなりました。どの HotSync マネージャ バージョンもこの値を使用しません。

互換性

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

参照

Username, CmGetCreatorUser()

CmSetCreatorValueDword 関数 ^TOP^

目的

ユーザ登録コンジットのための DWORD コンフィグレーション エントリの値をセットします。

宣言されている場所

CondMgr.h

Prototype

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

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの値をセットしようとしています。
  • → 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
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されています。そのため、このコンジットの登録情報は Read-only です。

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

コメント

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

この関数は現在の Windows ユーザのために登録されているコンジットの情報をセットします。システムのために登録されているコンジットの DWORD コンフィグレーション エントリ値をセットするには、CmSetSystemCreatorValueDword() を呼び出します。

互換性

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

参照

CmGetCreatorValueDword(), CmSetSystemCreatorValueDword(), CmSetCreatorValueString()

CmSetCreatorValueString 関数 ^TOP^

目的

ユーザ登録コンジットのための文字列コンフィグレーション エントリの値をセットします。

宣言されている場所

CondMgr.h

Prototype

int CmSetCreatorValueString (
   const char *pCreatorID,
   TCHAR *pValue,
   TCHAR *pString
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの値をセットしようとしています。
  • → pValue
    • コンフィグレーション エントリの名前。
  • → pString
    • あなたが指定されたコンジットの指定されたコンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_VALUE_NOT_FOUND
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されています。そのため、このコンジットの登録情報は Read-only です。

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

コメント

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

この関数は現在の Windows ユーザのために登録されているコンジットの情報をセットします。システムのために登録されているコンジットの DWORD コンフィグレーション エントリ文字列値をセットするには、CmSetSystemCreatorValueString() を呼び出します。

互換性

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

参照

CmGetCreatorValueString(), CmSetCreatorValueString(), CmSetSystemCreatorValueDword()

CmSetHotSyncExecPath 関数 ^TOP^

目的

(使用を推奨されなくなりました) 現在の Windows ユーザのための HotSync マネージャ実行形式ファイルのパスとファイル名をセットします。

宣言されている場所

CondMgr.h

Prototype

int CmSetHotSyncExecPath (
   const TCHAR *pPath
)

パラメータ

  • → pPath
    • デスクトップ コンピュータ上の HotSync マネージャ実行形式ファイルのパスとファイル名 - 例えば、:\Program Files\PalmSource\Desktop\HotSync.exe - を保持している文字バッファへのポインタ。

返り値

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

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

  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_POINTER

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

コメント

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

WARNING!
この関数を使用してはいけません。このパスを変更すると旧来のコンジット インストーラは失敗します。このパスを取得するには CmGetSystemHotSyncExecPath() を使用します。しかしながら、それを変更してはいけません。

この関数は現在の Windows ユーザのための Core\HotSyncPath コンフィグレーション エントリの値をセットします。詳細は CmGetSystemHotSyncExecPath() の説明を参照してください。

互換性

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

参照

CmGetHotSyncExecPath(), CmGetSystemHotSyncExecPath()

CmSetNotifierDll 関数 ^TOP^

目的

(使用を推奨されなくなりました) 通知 DLL の名前をセットします。

宣言されている場所

CondMgr.h

Prototype

int CmSetNotifierDll (
   int iIndex,
   const TCHAR *pNotifier
)

パラメータ

  • → iIndex
    • 通知機能の整数インデックス。あなたはこのインデックスをコンフィグレーション エントリにセットしようとしています。
  • → pNotifier
    • 通知機能として使用する DLL の名前。通知機能を削除するには NULL を渡します。

返り値

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

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

  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_POINTER

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

コメント

この関数は通知機能 DLL の名前をセットします。これはコンフィグレーション エントリの HotSync マネージャ部の中の値として保存されます。最初の通知機能コンフィグレーション エントリの名前は Notifier0 であり、2 番目の名前は Notifier1 などとなっています。

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

互換性

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

参照

NmRegister(), NmRegisterSystem()

CmSetPCIdentifier 関数 ^TOP^

目的

(使用を推奨されなくなりました) デスクトップ コンピュータ上の現在の Windows ユーザのための固有識別子をセットします。

宣言されている場所

CondMgr.h

Prototype

int CmSetPCIdentifier (
   DWORD dwPCID
)

パラメータ

  • → dwPCID
    • デスクトップ コンピュータのための識別子として使用する DWORD 値。

返り値

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

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

  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_POINTER

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

コメント

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

WARNING!
この関数を使用してはいけません。この値を取得するには CmGetPCIdentifier() を使用します。しかしながら、それを変更してはいけません。

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

互換性

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

参照

CmGetPCIdentifier()

CmSetSystemBackupConduit 関数 ^TOP^

目的

システムのためのバックアップ コンジットのパスまたはファイル名をセットします。

宣言されている場所

CondMgr.h

Prototype

int CmSetSystemBackupConduit (
   const TCHAR *pConduit
)

パラメータ

  • → pConduit
    • バックアップ コンジットとして使用されるコンジットのフル パスまたはファイル名。

返り値

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

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

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

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

コメント

この関数はコンフィグレーション エントリの中にある HotSync マネージャによって使用される Manager\BackupConduit エントリの値をセットします。あなたがファイル名を指定して、コンジット マネージャがそのファイルを見つけられない場合 (またはファイル名が NULL である場合)、この関数はファイル名を変更せずにエラーを返しません。この関数を呼び出す前に、あなたはコンジット マネージャが見つけられる場所にファイルが存在していることをチェックしなければなりません。

この関数はシステムのためのバックアップ コンジットをセットします。現在の Windows ユーザのためのバックアップ コンジットをセットするには、CmSetBackupConduit() を呼び出します。

互換性

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

参照

HotSync Manager\BackupConduit, CmGetSystemBackupConduit(), CmSetBackupConduit()

CmSetSystemCreatorDirectory 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int CmSetSystemCreatorDirectory (
   const char *pCreatorID,
   const TCHAR *pDirectory
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Directory 値をセットしようとしています。
  • → pDirectory
    • あなたが指定されたコンジットの Directory コンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_INSUFFICIENT_PRIVILEGES
    • 現在の Windows ユーザはこの操作を実行するのに十分な権限を持っていません。管理者権限が必要です。
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されたものであるため、登録情報は Read-only です。

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

コメント

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

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

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

互換性

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

参照

Directory, CmGetSystemCreatorDirectory(), CmSetCreatorDirectory()

CmSetSystemCreatorFile 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int CmSetSystemCreatorFile (
   const char *pCreatorID,
   const TCHAR *pFile
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの File 値をセットしようとしています。
  • → pFile
    • あなたが指定されたコンジットの File コンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_INSUFFICIENT_PRIVILEGES
    • 現在の Windows ユーザはこの操作を実行するのに十分な権限を持っていません。管理者権限が必要です。
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されています。そのため、このコンジットの登録情報は Read-only です。

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

コメント

この関数は指定されたコンジットの File コンフィグレーション エントリの値をセットします。ファイル文字列はハンドヘルド データベースと同期されるデスクトップ ファイルの名前を指定します。このファイルはどこにでも置くことができますが、一般には CmGetCreatorDirectory() によって返されるディレクトリの中に置きます。

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

互換性

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

参照

File, CmGetSystemCreatorFile(), CmSetCreatorFile()

CmSetSystemCreatorName 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int CmSetSystemCreatorName (
   const char *pCreatorID,
   const TCHAR *pConduitName
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID。あなたはこのコンジットの Conduit をセットしようとしています。
  • → pConduitName
    • あなたが指定されたコンジットの Conduit コンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_INSUFFICIENT_PRIVILEGES
    • 現在の Windows ユーザはこの操作を実行するのに十分な権限を持っていません。管理者権限が必要です。
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されています。そのため、このコンジットの登録情報は Read-only です。

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

コメント

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

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

互換性

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

参照

Conduit, CmGetSystemCreatorName(), CmSetCreatorName()

CmSetSystemCreatorPriority 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int CmSetSystemCreatorPriority (
   const char *pCreatorID,
   DWORD dwPriority
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID。あなたはこのコンジットの Priority をセットしようとしています。
  • → dwPriority
    • あなたが指定されたコンジットの Priority コンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_INSUFFICIENT_PRIVILEGES
    • 現在の Windows ユーザはこの操作を実行するのに十分な権限を持っていません。管理者権限が必要です。
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されています。そのため、このコンジットの登録情報は Read-only です。

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

コメント

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

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

互換性

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

参照

Priority, CmGetSystemCreatorPriority(), CmSetCreatorPriority()

CmSetSystemCreatorRemote 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int CmSetSystemCreatorRemote (
   const char *pCreatorID,
   const TCHAR *pRemoteDB
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID。あなたはこのコンジットの Remote をセットしようとしています。
  • → pRemoteDB
    • あなたが指定されたコンジットの Remote コンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_INSUFFICIENT_PRIVILEGES
    • 現在の Windows ユーザはこの操作を実行するのに十分な権限を持っていません。管理者権限が必要です。
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されています。そのため、このコンジットの登録情報は Read-only です。

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

コメント

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

NOTE
コンジットはハンドヘルド上の複数のデータベースにアクセスすることができます。しかしながら、CmSetSystemCreatorRemote() が指定するのはただ 1 つのデータベース名であり、それはこのコンジットの Remote コンフィグレーション エントリに保存されます。"Remote" の説明があなたがこのコンフィグレーション エントリを使用すべきかどうかを決定するのを助けてくれます。

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

互換性

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

参照

Remote, CmGetSystemCreatorRemote(), CmSetCreatorRemote()

CmSetSystemCreatorTitle 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

Prototype 
int CmSetSystemCreatorTitle (
   const char *pCreatorID,
   const TCHAR *pTitle
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Name 値をセットしようとしています。
  • → pTitle
    • あなたが指定されたコンジットの Name コンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_INSUFFICIENT_PRIVILEGES
    • 現在の Windows ユーザはこの操作を実行するのに十分な権限を持っていません。管理者権限が必要です。
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されています。そのため、このコンジットの登録情報は Read-only です。

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

コメント

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

この関数はシステムのために登録されているコンジットの情報をセットします。現在の Windows ユーザのために登録されているコンジットの表示名をセットするには、CmSetCreatorTitle() を呼び出します。

互換性

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

参照

Name, CmGetSystemCreatorTitle(), CmSetCreatorTitle()

CmSetSystemCreatorValueDword 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

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

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの値をセットしようとしています。
  • → 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
  • ERR_INSUFFICIENT_PRIVILEGES
    • 現在の Windows ユーザはこの操作を実行するのに十分な権限を持っていません。管理者権限が必要です。
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されています。そのため、このコンジットの登録情報は Read-only です。

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

コメント

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

この関数はシステムのために登録されているコンジットの情報をセットします。現在の Windows ユーザのために登録されているコンジットの DWORD コンフィグレーション エントリ値をセットするには、CmSetCreatorValueDword() を呼び出します。

互換性

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

参照

CmGetSystemCreatorValueDword(), CmSetCreatorValueString(), CmSetSystemCreatorValueDword()

CmSetSystemCreatorValueString 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int CmSetSystemCreatorValueString (
   const char *pCreatorID,
   TCHAR *pValue,
   TCHAR *pString
)

パラメータ

  • → pCreatorID
    • コンジットのクリエイタ ID 文字列。あなたはこのコンジットの値をセットしようとしています。
  • → pValue
    • コンフィグレーション エントリの名前。
  • → pString
    • あなたが指定されたコンジットの指定されたコンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_AMBIGUOUS_CREATORID
  • ERR_NO_CONDUIT
  • ERR_REGISTRY_ACCESS
  • ERR_INVALID_CREATOR_ID
  • ERR_INVALID_POINTER
  • ERR_VALUE_NOT_FOUND
  • ERR_INSUFFICIENT_PRIVILEGES
    • 現在の Windows ユーザはこの操作を実行するのに十分な権限を持っていません。管理者権限が必要です。
  • ERR_CONDUIT_READ_ONLY
    • 指定されたコンジットはフォルダ登録されています。そのため、このコンジットの登録情報は Read-only です。

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

コメント

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

この関数はシステムのために登録されているコンジットの情報をセットします。現在の Windows ユーザのために登録されているコンジットの DWORD コンフィグレーション エントリ文字列値をセットするには、CmSetCreatorValueString() を呼び出します。

互換性

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

参照

CmGetSystemCreatorValueString(), CmSetSystemCreatorValueDword(), CmSetCreatorValueString()

FmDisableCurrentUserConduitByIndex 関数 ^TOP^

目的

与えれられたインデックスで現在の Windows ユーザの Conduits フォルダの中にあるコンジットを使用不可にします。

宣言されている場所

CondMgr.h

Prototype

int FmDisableCurrentUserConduitByIndex (
   int iIndex
)

パラメータ

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

返り値

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

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

  • ERR_FOLDER_NOT_FOUND
    • 指定されたコンジットを使用不可にすることができません。なぜなら、Conduits フォルダか Disabled フォルダが存在せず、作成することもできないからです。
  • ERR_INDEX_OUT_OF_RANGE
    • 指定されたインデックス値は範囲外です。

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

コメント

この関数は現在の Windows ユーザのためにフォルダ登録されたコンジットを Conduits フォルダから Disabled フォルダに移動させます。このアクションはコンジットの登録を解除するため、HotSync マネージャはそのコンジットのすべてのエントリ ポイントを呼び出せなくなります。

この関数が呼び出されたとき、コンジット マネージャは iIndex パラメータを処理する前に現在の Windows ユーザの Conduits フォルダと Disabled フォルダが存在するかどうかをチェックします。どちらかが存在しない場合、この関数は ERR_FOLDER_NOT_FOUND を返します。FmGetCurrentUserConduitFolder()FmGetCurrentUserDisabledConduitFolder() を呼び出すと、それらのフォルダが存在しない場合それらのフォルダが作成され、フォルダのパスが返されます。

iIndex が現在の Windows ユーザのために登録されているフォルダ ベース コンジットの有効なインデックス範囲内である場合、コンジット マネージャはそのコンジットを Disabled フォルダに移動させます。範囲外である場合、ERR_INDEX_OUT_OF_RANGE を返します。

この関数は現在の Windows ユーザのための フォルダ登録コンジット に対してのみ処理を行います。通常通りの方法で登録されたコンジットの登録を解除するには、CmRemoveConduitByIndex() を呼び出します。

互換性

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

参照

FmEnableCurrentUserConduitByPath(), FmGetCurrentUserConduitFolder(), FmDisableSystemConduitByIndex()

FmDisableCurrentUserConduitByPath 関数 ^TOP^

目的

与えれられたコンジットのパスまたはファイル名で現在の Windows ユーザの Conduits フォルダの中にあるコンジットを使用不可にします。

宣言されている場所

CondMgr.h

Prototype

int FmDisableCurrentUserConduitByPath (
   TCHAR *pPath
)

パラメータ

  • → pPath
    • Conduits フォルダの中にあるコンジットのフル パスまたはファイル名のどちらかを保持している文字バッファへのポインタ。あなたはこのコンジットを使用不可にしようとしています。

返り値

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

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

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

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

コメント

この関数は現在の Windows ユーザのためにフォルダ登録されたコンジットを Conduits フォルダから Disabled フォルダに移動させます。このアクションはコンジットの登録を解除するため、HotSync マネージャはそのコンジットのすべてのエントリ ポイントを呼び出せなくなります。

この関数が呼び出されたとき、コンジット マネージャは pPath パラメータを処理する前に現在の Windows ユーザの Conduits フォルダと Disabled フォルダが存在するかどうかをチェックします。どちらかが存在しない場合、この関数は ERR_FOLDER_NOT_FOUND を返します。FmGetCurrentUserConduitFolder()FmGetCurrentUserDisabledConduitFolder() を呼び出すと、それらのフォルダが存在しない場合それらのフォルダが作成され、フォルダのパスが返されます。

pPath がファイル名だけである場合、コンジット マネージャは現在の Windows ユーザの Conduits フォルダのパスをファイル名の前に付けます。コンジット マネージャは使用不可にするコンジットを置く場所を決定するためにフル パスとファイル名を使用します。pPath が使用不可にするコンジットのフル パスとファイル名である場合、コンジット マネージャは pPath が現在の Windows ユーザのための正確なパスであると見なします。Coduits フォルダが存在しない場合、この関数は ERR_FOLDER_NOT_FOUND を返します。

この関数は現在の Windows ユーザのための フォルダ登録コンジット に対してのみ処理を行います。通常通りの方法で登録されたコンジットの登録を解除するには、CmRemoveConduitByCreatorID() を呼び出します。

互換性

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

参照

FmEnableCurrentUserConduitByPath(), FmGetCurrentUserConduitFolder(), FmDisableSystemConduitByIndex()

FmDisableSystemConduitByIndex 関数 ^TOP^

目的

与えれられたインデックスでシステムの Conduits フォルダの中にあるコンジットを使用不可にします。

宣言されている場所

CondMgr.h

Prototype

int FmDisableSystemConduitByIndex (
   int iIndex
)

パラメータ

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

返り値

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

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

  • ERR_FOLDER_NOT_FOUND
    • 指定されたコンジットを使用不可にすることができません。なぜなら、Conduits フォルダか Disabled フォルダが存在せず、作成することもできないからです。
  • ERR_INDEX_OUT_OF_RANGE
    • 指定されたインデックス値は範囲外です。
  • ERR_INSUFFICIENT_PRIVILEGES
    • 現在の Windows ユーザはこの操作を実行するのに十分な権限を持っていません。NTFS ファイル システムに対して処理を行う場合には管理者権限が必要です。

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

コメント

この関数はシステムのためにフォルダ登録されたコンジットを Conduits フォルダから Disabled フォルダに移動させます。このアクションはコンジットの登録を解除するため、HotSync マネージャはそのコンジットのすべてのエントリ ポイントを呼び出せなくなります。

この関数が呼び出されたとき、コンジット マネージャは iIndex パラメータを処理する前にシステムの Conduits フォルダと Disabled フォルダが存在するかどうかをチェックします。どちらかが存在しない場合、この関数は ERR_FOLDER_NOT_FOUND を返します。FmGetSystemConduitFolder()FmGetSystemDisabledConduitFolder() を呼び出すと、それらのフォルダが存在しない場合それらのフォルダが作成され、フォルダのパスが返されます。

iIndex がシステムのために登録されているフォルダ ベース コンジットの有効なインデックス範囲内である場合、コンジット マネージャはそのコンジットを Disabled フォルダに移動させます。範囲外である場合、ERR_INDEX_OUT_OF_RANGE を返します。

この関数はシステムのための フォルダ登録コンジット に対してのみ処理を行います。通常通りの方法で登録されたコンジットの登録を解除するには、CmRemoveSystemConduitByIndex() を呼び出します。

互換性

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

参照

FmEnableSystemConduitByPath(), FmGetSystemConduitFolder(), FmDisableSystemConduitByPath(), FmDisableCurrentUserConduitByPath()

FmDisableSystemConduitByPath 関数 ^TOP^

目的

与えれられたコンジットのパスまたはファイル名でシステムの Conduits フォルダの中にあるコンジットを使用不可にします。

宣言されている場所

CondMgr.h

Prototype

int FmDisableSystemConduitByPath (
   TCHAR *pPath
)

パラメータ

  • → pPath
    • Conduits フォルダの中にあるコンジットのフル パスまたはファイル名のどちらかを保持している文字バッファへのポインタ。あなたはこのコンジットを使用不可にしようとしています。

返り値

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

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

  • ERR_FOLDER_NOT_FOUND
    • 指定されたコンジットを使用不可にすることができません。なぜなら、Conduits フォルダか Disabled フォルダが存在せず、作成することもできないからです。
  • ERR_INVALID_POINTER
  • ERR_INSUFFICIENT_PRIVILEGES
    • 現在の Windows ユーザはこの操作を実行するのに十分な権限を持っていません。NTFS ファイル システムに対して処理を行う場合には管理者権限が必要です。

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

コメント

この関数はシステムのためにフォルダ登録されたコンジットを Conduits フォルダから Disabled フォルダに移動させます。このアクションはコンジットの登録を解除するため、HotSync マネージャはそのコンジットのすべてのエントリ ポイントを呼び出せなくなります。

この関数が呼び出されたとき、コンジット マネージャは pPath パラメータを処理する前にシステムの Conduits フォルダと Disabled フォルダが存在するかどうかをチェックします。どちらかが存在しない場合、この関数は ERR_FOLDER_NOT_FOUND を返します。FmGetSystemConduitFolder()FmGetSystemDisabledConduitFolder() を呼び出すと、それらのフォルダが存在しない場合それらのフォルダが作成され、フォルダのパスが返されます。

pPath がファイル名だけである場合、コンジット マネージャはシステムの Conduits フォルダのパスをファイル名の前に付けます。コンジット マネージャは使用不可にするコンジットを置く場所を決定するためにフル パスとファイル名を使用します。pPath が使用不可にするコンジットのフル パスとファイル名である場合、コンジット マネージャは pPath がシステムのための正確なパスであると見なします。Coduits フォルダが存在しない場合、この関数は ERR_FOLDER_NOT_FOUND を返します。

この関数はシステムのための フォルダ登録コンジット に対してのみ処理を行います。通常通りの方法で登録されたコンジットの登録を解除するには、CmRemoveSystemConduitByCreatorID() を呼び出します。

互換性

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

参照

FmEnableSystemConduitByPath(), FmGetSystemConduitFolder(), FmDisableSystemConduitByIndex(), FmDisableCurrentUserConduitByPath()

FmEnableCurrentUserConduitByPath 関数 ^TOP^

目的

与えられたコンジットのパスまたはファイル名で現在の Windows ユーザの Disabled フォルダの中にあるコンジットを使用可能にします。

宣言されている場所

CondMgr.h

Prototype

int FmEnableCurrentUserConduitByPath (
   TCHAR *pPath
)

パラメータ

  • → pPath
    • Disabled フォルダの中にあるコンジットのフル パスとファイル名あるいはファイル名だけのどちらかを保持している文字バッファへのポインタ。あなたはこのコンジットを使用可能にしようとしています。

返り値

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

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

  • ERR_FOLDER_NOT_FOUND
    • 指定されたコンジットを使用可能にすることはできません。なぜなら、Conduits フォルダか Disabled フォルダは存在せず、作成することもできないからです。
  • ERR_INVALID_POINTER

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

コメント

この関数は現在の Windows ユーザのためにフォルダ登録されたコンジットを Disabled フォルダから Conduits フォルダに移動させます。このアクションはコンジットを登録するため、HotSync マネージャはそのコンジットのいずれかのエントリ ポイントを呼び出せるようになります。

この関数が呼び出されたとき、コンジット マネージャは pPath パラメータを処理する前に現在の Windows ユーザの Conduits フォルダと Disabled フォルダが存在するかどうかをチェックします。どちらかが存在しない場合、この関数は ERR_FOLDER_NOT_FOUND を返します。FmGetCurrentUserConduitFolder()FmGetCurrentUserDisabledConduitFolder() を呼び出すと、それらのフォルダが存在しない場合それらのフォルダが作成され、フォルダのパスが返されます。

pPath がファイル名だけである場合、コンジット マネージャは現在の Windows ユーザの Disabled フォルダのパスをファイル名の前に付けます。コンジット マネージャは使用可能にするコンジットを置く場所を決定するためにフル パスとファイル名を使用します。pPath が使用可能にするコンジットのフル パスとファイル名である場合、コンジット マネージャは pPath が現在の Windows ユーザのための正確なパスであると見なします。Disabled フォルダが存在しない場合、この関数は ERR_FOLDER_NOT_FOUND を返します。

この関数は現在の Windows ユーザのための フォルダ登録コンジット に対してのみ処理を行います。通常通りの方法で登録されたコンジットの登録を解除するには、CmInstallConduitByCreatorID() を呼び出します。

互換性

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

参照

FmDisableCurrentUserConduitByPath(), FmGetCurrentUserDisabledConduitFolder(), FmEnableSystemConduitByPath()

FmEnableSystemConduitByPath 関数 ^TOP^

目的

与えられたコンジットのパスまたはファイル名でシステムの Disabled フォルダの中にあるコンジットを使用可能にします。

宣言されている場所

CondMgr.h

Prototype

int FmEnableSystemConduitByPath (
   TCHAR *pPath
)

パラメータ

  • → pPath
    • Disabled フォルダの中にあるコンジットのフル パスとファイル名あるいはファイル名だけのどちらかを保持している文字バッファへのポインタ。あなたはこのコンジットを使用可能にしようとしています。

返り値

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

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

  • ERR_FOLDER_NOT_FOUND
    • 指定されたコンジットを使用可能にすることはできません。なぜなら、Conduits フォルダか Disabled フォルダは存在せず、作成することもできないからです。
  • ERR_INVALID_POINTER
  • ERR_INSUFFICIENT_PRIVILEGES
    • 現在の Windows ユーザはこの操作を実行するのに十分な権限を持っていません。NTFS ファイル システムに対して処理を行う場合には管理者権限が必要です。

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

コメント

この関数はシステムのためにフォルダ登録されたコンジットを Disabled フォルダから Conduits フォルダに移動させます。このアクションはコンジットを登録をするため、HotSync マネージャはそのコンジットのいずれかのエントリ ポイントを呼び出せるようになります。

この関数が呼び出されたとき、コンジット マネージャは pPath パラメータを処理する前にシステムの Conduits フォルダと Disabled フォルダが存在するかどうかをチェックします。どちらかが存在しない場合、この関数は ERR_FOLDER_NOT_FOUND を返します。FmGetSystemConduitFolder()FmGetSystemDisabledConduitFolder() を呼び出すと、それらのフォルダが存在しない場合それらのフォルダが作成され、フォルダのパスが返されます。

pPath がファイル名だけである場合、コンジット マネージャはシステムの Disabled フォルダのパスをファイル名の前に付けます。コンジット マネージャは使用可能にするコンジットを置く場所を決定するためにフル パスとファイル名を使用します。pPath が使用可能にするコンジットのフル パスとファイル名である場合、コンジット マネージャは pPath がシステムのための正確なパスであると見なします。Disabled フォルダが存在しない場合、この関数は ERR_FOLDER_NOT_FOUND を返します。

この関数はシステムのための フォルダ登録コンジット に対してのみ処理を行います。通常通りの方法で登録されたコンジットの登録を解除するには、CmRemoveSystemConduitByIndex() を呼び出します。

互換性

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

参照

FmDisableSystemConduitByPath(), FmGetSystemDisabledConduitFolder(), FmEnableCurrentUserConduitByPath()

FmGetCurrentUserConduitByIndex 関数 ^TOP^

目的

与えられたコンジットのインデックスで現在の Windows ユーザのために登録されているフォルダ ベース コンジットについての情報を取得します。

宣言されている場所

CondMgr.h

Prototype

int FmGetCurrentUserConduitByIndex (
   int iIndex,
   CmConduitType2 &sConduitInfo
)

パラメータ

  • → iIndex
    • 現在の Windows ユーザのために登録されているフォルダ ベース コンジットのインデックス (0 ベース)。インデックスの最大値を決定するには FmGetCurrentUserConduitCount() を呼び出します。
  • ← sConduitInfo
    • 指定されたコンジットについて記述している CmConduitType2 構造体への参照。

返り値

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

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

  • ERR_INDEX_OUT_OF_RANGE
    • 指定されたインデックスは範囲外です。
  • ERR_FOLDER_NOT_FOUND
    • 指定されたコンジットについての情報を取得することはできません。なぜなら、Conduits フォルダか Disabled フォルダは存在せず、作成することもできないからです。

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

コメント

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

互換性

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

参照

CmConduitType2, FmGetCurrentUserConduitCount(), FmGetSystemConduitByIndex()

FmGetCurrentUserConduitCount 関数 ^TOP^

目的

現在の Windows ユーザのために HotSync マネージャに登録されているフォルダ ベース コンジットの数を返します。

宣言されている場所

CondMgr.h

Prototype

int FmGetCurrentUserConduitCount (
   void
)

パラメータ

ありません。

返り値

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

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

  • ERR_FOLDER_NOT_FOUND
    • 登録されているコンジットの数を取得することはできません。なぜなら、Conduits フォルダか Disabled フォルダは存在せず、作成することもできないからです。

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

コメント

返される数には現在の Windows ユーザのために登録されているフォルダ ベース コンジットの数だけが含まれます。この数にはシステム登録コンジットは含まれません。システムのために登録されているフォルダ ベース コンジットの数を取得するには、FmGetSystemConduitCount() を呼び出します。

互換性

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

参照

FmGetSystemConduitCount(), FmGetCurrentUserConduitByIndex(), FmDisableCurrentUserConduitByIndex()

FmGetCurrentUserConduitFolder 関数 ^TOP^

目的

現在の Windows ユーザの Conduits フォルダのパスを取得します。

宣言されている場所

CondMgr.h

Prototype

int FmGetCurrentUserConduitFolder (
   TCHAR *pPath,
   int *piSize
)

パラメータ

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

返り値

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

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

  • ERR_FOLDER_NOT_FOUND
    • Conduits フォルダは存在せず、作成することもできません。
  • ERR_INVALID_POINTER
    • 1 つまたは複数の入力パラメータが NULL であるか、さもなければ無効なポインタです。
  • ERR_BUFFER_TOO_SMALL
    • 提供されたバッファは小さすぎます。この関数は返り時に必要とされるサイズを piSize パラメータ経由で返します。

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

コメント

この関数は現在の Windows ユーザのための Conduits フォルダが存在しているかどうかをチェックします。フォルダが存在している場合、コンジット マネージャはそのパスを取得します。フォルダが存在しない場合、コンジット マネージャは現在の Windows ユーザのための Conduits フォルダを作成しようと試みます。それゆえ、この関数がパスを返す場合、Conduits フォルダは存在します。

互換性

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

参照

FmGetCurrentUserDisabledConduitFolder(), FmGetSystemConduitFolder()

FmGetCurrentUserDisabledConduitFolder 関数 ^TOP^

目的

現在の Windows ユーザの Disabled フォルダのパスを取得します。

宣言されている場所

CondMgr.h

Prototype

int FmGetCurrentUserDisabledConduitFolder (
   TCHAR *pPath,
   int *piSize
)

パラメータ

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

返り値

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

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

  • ERR_FOLDER_NOT_FOUND
    • Disabled フォルダは存在せず、作成することもできません。
  • ERR_INVALID_POINTER
    • 1 つまたは複数の入力パラメータが NULL であるか、さもなければ無効なポインタです。
  • ERR_BUFFER_TOO_SMALL
    • 提供されたバッファは小さすぎます。この関数は返り時に必要とされるサイズを piSize パラメータ経由で返します。

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

コメント

この関数は現在の Windows ユーザのための Disabled フォルダが存在しているかどうかをチェックします。フォルダが存在している場合、コンジット マネージャはそのパスを取得します。フォルダが存在しない場合、コンジット マネージャは現在の Windows ユーザのための Disabled フォルダを作成しようと試みます。それゆえ、この関数がパスを返す場合、Disabled フォルダは存在します。

互換性

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

参照

FmGetCurrentUserConduitFolder(), FmGetSystemDisabledConduitFolder()

FmGetSystemConduitByIndex 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int FmGetSystemConduitByIndex (
   int iIndex,
   CmConduitType2 &sConduitInfo
)

パラメータ

  • → iIndex
    • システムのために登録されているフォルダ ベース コンジットのインデックス (0 ベース)。インデックスの最大値を決定するには FmGetSystemConduitCount() を呼び出します。
  • ← sConduitInfo
    • 指定されたコンジットについて記述している CmConduitType2 構造体への参照。

返り値

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

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

  • ERR_INDEX_OUT_OF_RANGE
    • 指定されたインデックスは範囲外です。
  • ERR_FOLDER_NOT_FOUND
    • 指定されたコンジットについての情報を取得することはできません。なぜなら、Conduits フォルダか Disabled フォルダは存在せず、作成することもできないからです。

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

コメント

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

互換性

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

参照

CmConduitType2, FmGetSystemConduitCount(), FmGetCurrentUserConduitByIndex()

FmGetSystemConduitCount 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int FmGetSystemConduitCount (
   void
)

パラメータ

ありません。

返り値

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

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

  • ERR_FOLDER_NOT_FOUND
    • 登録されているコンジットの数を取得することはできません。なぜなら、Conduits フォルダか Disabled フォルダは存在せず、作成することもできないからです。

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

コメント

返される数にはシステムのために登録されているフォルダ ベース コンジットの数だけが含まれます。この数にはユーザ登録コンジットは含まれません。現在の Windows ユーザのために登録されているフォルダ ベース コンジットの数を取得するには、FmGetCurrentUserConduitCount() を呼び出します。

互換性

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

参照

FmGetCurrentUserConduitCount(), FmGetSystemConduitByIndex(), FmDisableSystemConduitByIndex()

FmGetSystemConduitFolder 関数 ^TOP^

目的

システムの Conduits フォルダのパスを取得します。

宣言されている場所

CondMgr.h

Prototype

int FmGetSystemConduitFolder (
   TCHAR *pPath,
   int *piSize
)

パラメータ

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

返り値

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

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

  • ERR_FOLDER_NOT_FOUND
    • Conduits フォルダは存在せず、作成することもできません。
  • ERR_INVALID_POINTER
    • 1 つまたは複数の入力パラメータが NULL であるか、さもなければ無効なポインタです。
  • ERR_BUFFER_TOO_SMALL
    • 提供されたバッファは小さすぎます。この関数は返り時に必要とされるサイズを piSize パラメータ経由で返します。

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

コメント

この関数はシステムのための Conduits フォルダが存在しているかどうかをチェックします。フォルダが存在している場合、コンジット マネージャはそのパスを取得します。フォルダが存在しない場合、コンジット マネージャはシステムのための Conduits フォルダを作成しようと試みます。それゆえ、この関数がパスを返す場合、Conduits フォルダは存在します。

互換性

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

参照

FmGetSystemDisabledConduitFolder(), FmGetCurrentUserConduitFolder()

FmGetSystemDisabledConduitFolder 関数 ^TOP^

目的

システムの Disabled フォルダのパスを取得します。

宣言されている場所

CondMgr.h

Prototype

int FmGetSystemDisabledConduitFolder (
   TCHAR *pPath,
   int *piSize
)

パラメータ

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

返り値

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

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

  • ERR_FOLDER_NOT_FOUND
    • Disabled フォルダは存在せず、作成することもできません。
  • ERR_INVALID_POINTER
    • 1 つまたは複数の入力パラメータが NULL であるか、さもなければ無効なポインタです。
  • ERR_BUFFER_TOO_SMALL
    • 提供されたバッファは小さすぎます。この関数は返り時に必要とされるサイズを piSize パラメータ経由で返します。

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

コメント

この関数はシステムのための Disabled フォルダが存在しているかどうかをチェックします。フォルダが存在している場合、コンジット マネージャはそのパスを取得します。フォルダが存在しない場合、コンジット マネージャはシステムのための Disabled フォルダを作成しようと試みます。それゆえ、この関数がパスを返す場合、Disabled フォルダは存在します。

互換性

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

参照

FmGetSystemConduitFolder(), FmGetCurrentUserDisabledConduitFolder()

コンジット マネージャ エラー コード ^TOP^

表 11.1 はコンジット マネージャ関数が返す可能性のあるエラー コードの値をリスト アップしています。各関数の説明ではその関数が返す可能性のあるエラーを挙げています。

以下の名前を付けられているすべてのエラー コードはプリプロセッサ定数として定義されていて、宣言は CondMgr.h ヘッダ ファイルの中で行われています。


表 11.1 コンジット マネージャ エラー コード

エラー コード 説明
-1029 ERR_CONFLICTING_EXTENSION 指定されたファイル拡張子はすでに他のインストール コンジットに対して登録されています。
-1028 ERR_COULD_NOT_CREATE_DIRECTORY Core\Path コンフィグレーション エントリを指定された値にセットすることができませんでした。ディレクトリを作成することができなかったためです。
-1027 ERR_AMBIGUOUS_CREATORID すでに 1 つまたはそれ以上のフォルダ ベース コンジットが指定された作成者 ID で登録されています。衝突を解決して、この関数を再び呼び出してください。C/C++ Sync Suite Companion「コンジット衝突の解決」 を参照してください。
-1026 ERR_CONDUIT_READ_ONLY 指定されたコンジットはフォルダ登録です。それゆえ、その登録情報は Read-only です。すべての CmSetCreator...() 関数と CmSetSystemCreator...() 関数はこのエラーを返す可能性があります。
-1025 ERR_FOLDER_NOT_FOUND Conduits または Disabled フォルダは存在せず、作成することもできません。
-1024 ERR_INSUFFICIENT_PRIVILEGES 現在の Windows ユーザはこの操作を行うための十分な権限を持っていません。システム レベルの変更を行うには管理者権限が必要ですが、システム レベル情報を読み込むのには必要ではありません。このエラーはシステム レベル領域にあるコンジットを移動させる呼び出しによって返される可能性があります。しかしながら、ユーザが管理者権限を持っておらず、かつ、NTFS ファイル システムの場合にのみです。
-1023 ERR_INVALID_INSTALL_ID インストール コンジットに指定された固有 ID は有効ではありません。
-1022 ERR_INSTALL_ID_ALREADY_IN_USE インストール コンジットに指定された固有 ID はすでに使用されています。
-1021 ERR_NOTIFIER_NOT_FOUND 指定された通知昨日は登録されていません。
-1019 ERR_ALREADY_INSTALLED 指定されたコンジットまたは通知機能はすでにインストールされています。
-1018 ERR_INVALID_PATH 指定されたパスは有効ではありません。
-1017 ERR_NO_LONGER_SUPPORTED あなたが指定した値または Feature はもはやサポートされていません。
-1016 ERR_INVALID_COM_PORT_TYPE 指定された通信ポート タイプは有効ではありません。あなたは 「通信ポート」 で説明されている値の 1 つを使用しなければなりません。
-1015 ERR_INVALID_CONDUIT_TYPE 指定されたコンジット タイプは有効ではありません。あなたは 「コンジット情報タイプ」 で説明されている値の 1 つを使用しなければなりません。
-1014 ERR_UNABLE_TO_INSTALL_OLD このエラー コードを返す関数はありません。
-1013 ERR_INVALID_POINTER 指定されたポインタは有効なポインタではありません。
-1012 ERR_INVALID_CREATOR_ID 指定されたコンジット作成者 ID は有効ではありません。
-1011 ERR_VALUE_NOT_FOUND 指定された値はこのコンジットのコンフィグレーション エントリでは見つかりませんでした。
-1010 ERR_BUFFER_TOO_SMALL バッファは要求された情報を保持するには小さすぎます。
-1009 ERR_INVALID_HANDLE 指定された構造体ハンドルは有効ではありません。
-1008 ERR_UNABLE_TO_SET_CONDUIT_VALUE 指定されたコンジット コンフィグレーション エントリをセットすることができませんでした。
-1007 ERR_UNABLE_TO_CREATE_CONDUIT コンジットを HotSync マネージャに登録することができませんでした。
-1006 ERR_REGISTRY_ACCESS コンジット コンフィグレーション エントリにアクセスすることができません。
-1006 ERR_STORAGE_ACCESS コンジット コンフィグレーション エントリにアクセスすることができません。
-1005 ERR_CREATORID_ALREADY_IN_USE あなたがコンフィグレーション エントリの中で新しい作成者 ID として指定した作成者 ID はすでに使用されています。
-1004 ERR_NO_MEMORY 要求された操作を行うにはメモリが不足しています。
-1003 ERR_NO_CONDUIT 指定されたコンジットは存在しません。
-1002 ERR_UNABLE_TO_DELETE 指定されたコンジットのコンフィグレーション エントリを削除することができませんでした。
-1001 ERR_INDEX_OUT_OF_RANGE 指定されたインデックス値は範囲外です。
-1000 ERR_CONDUIT_MGR 特定されないコンジット マネージャ エラーが起きました。

← 11 章のページ 2 へ ↑ 11 章のトップへ

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