Palm Programmer's Laboratory

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

C/C++ Sync Suite Reference601/12

← 11 章に戻る ↑トップへ 13 章に進む →

12 インストール コンジット マネージャ API

インストール コンジット マネージャはインストール コンジットを HotSync マネージャに登録するための API の提供します。インストール コンジット はデータベースをハンドヘルドのメイン メモリか拡張スロット上のファイルにインストールすることができます。

さらにこの API は、あなたがインストール コンジットを登録するときにインストール コンジット マネージャが作成するインストール コンジット コンフィグレーション エントリにアクセスするためのユーティリティ関数を提供します。各コンフィグレーション エントリの定義については、Introduction to Conduit Development付録 A 「コンフィグレーション エントリ」 を参照してください。

インストール コンジット マネージャ関数は CondMgr.dll で利用可能であり (この DLL はコンジット マネージャ関数も含みます)、CondMgr.h で宣言されています。

この章は以下の節に分かれています:

インストール コンジット マネージャについての更なる情報は、C/C++ Sync Suite Companion「インストール コンジット マネージャ API の使用 を参照してください。

インストール コンジット マネージャ構造体 ^TOP^

この節では、あなたが ImRegister()ImRegisterSystem() 関数で使用する FileInstallType データ構造体について説明します。

FileInstallType 構造体 ^TOP^

目的

あなたがあなたのインストール コンジットを登録するために ImRegister() または ImRegisterSystem() を呼び出すときに、あなたのインストール コンジットについての登録情報を指定します。

宣言されている場所

CondMgr.h

Prototyoe

typedef struct {
   TCHAR szDir[ 64 ];
   TCHAR szExt[ 256];
   DWORD dwMask;
   TCHAR szModule[ 256 ];
   DWORD dwCreatorID;
   TCHAR szName[ 256 ];
} FileInstallType

フィールド

  • szDir
    • このインストール コンジットに関連付けされるハンドヘルド インストール ディレクトリの名前を指定します - 例えば、"Install" です。この値はインストール コンジットの Directory コンフィグレーション エントリの中にセットされます。
  • szExt
    • このインストール コンジットによってサポートされるファイル タイプ拡張子を指定します。この値はインストール コンジットの Extensions コンフィグレーション エントリの中にセットされます。
  • dwMask
    • このインストール コンジットに関連付けされる固有のビット マスクを指定します。この値はインストール コンジットの Mask コンフィグレーション エントリの中にセットされます。
  • szModule
    • このインストール コンジット DLL のファイル名を指定します - 例えば、"inscn20.dll" です。この値はインストール コンジットの Module コンフィグレーション エントリの中にセットされます。
  • dwCreatorID
    • このインストール コンジットに関連付けされる固有の ID を指定します。この値はインストール コンジットの CreatorID コンフィグレーション エントリの中にセットされます。
  • szName
    • このインストール コンジットの表示名を指定します - 例えば、"Install Conduit" です。この値はインストール コンジットの Name コンフィグレーション エントリの中にセットされます。

コメント

これらのフィールドはそれぞれ 表 A.2 で説明されているインストール コンジット コンフィグレーション エントリに対応します。

互換性

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

参照

ImRegister(), ImRegisterSystem()

インストール コンジット マネージャ関数 ^TOP^

この節では、あなたがインストール コンジットを登録し、そのインストール コンジットの コンフィグレーション エントリ から情報を取得することを可能にする以下の関数について説明します。

関数 説明
ImGetDirectory ユーザ登録インストール コンジットがインストールするファイルを見つけ出すディレクトリの名前を取得します。
ImGetDWord ユーザ登録インストール コンジットの DWORD コンフィグレーション エントリ値を取得します。
ImGetExtension ユーザ登録インストール コンジットによってサポートされるファイル拡張子を取得します。
ImGetMask ユーザ登録インストール コンジットのビット マスクの値を取得します。
ImGetModule ユーザ登録インストール コンジットのファイル名を取得します。
ImGetName ユーザ登録インストール コンジットの表示名を取得します。
ImGetString ユーザ登録インストール コンジットの文字列コンフィグレーション エントリを取得します。
ImGetSystemDirectory システム登録インストール コンジットがインストールするファイルを見つけ出すディレクトリの名前を取得します。
ImGetSystemDWord システム登録インストール コンジットの DWORD コンフィグレーション エントリ値を取得します。
ImGetSystemExtension システム登録インストール コンジットによってサポートされるファイル拡張子を取得します。
ImGetSystemMask システム登録インストール コンジットのビット マスクの値を取得します。
ImGetSystemModule システム登録インストール コンジットのファイル名を取得します。
ImGetSystemName システム登録インストール コンジットの表示名を取得します。
ImGetSystemString システム登録インストール コンジットの文字列コンフィグレーション エントリを取得します。
ImRegister インストール コンジットを現在の Windows ユーザのために HotSync マネージャに登録します。FileInstallType 構造体を使用します。
ImRegisterID インストール コンジットの新しい固有 ID を現在の Windows ユーザのために HotSync マネージャに登録します (登録を完了するには他の ImSet...()) 関数を呼び出すことが必要です。
ImRegisterSystem インストール コンジットをシステムのために HotSync マネージャに登録します。FileInstallType 構造体を使用します。
ImRegisterSystemID インストール コンジットの新しい固有 ID をシステムのために HotSync マネージャに登録します (登録を完了するには他の ImSetSystem...()) 関数を呼び出すことが必要です。
ImSetDirectory ユーザ登録インストール コンジットがインストールするファイルを探し出すディレクトリの名前をセットします。
ImSetDWord ユーザ登録インストール コンジットの DWORD コンフィグレーション エントリ値をセットします。
ImSetExtension ユーザ登録インストール コンジットによってサポートされるファイル拡張子をセットします。
ImSetMask ユーザ登録インストール コンジットのビット マスクの値をセットします。
ImSetModule ユーザ登録インストール コンジットのファイル名をセットします。
ImSetName ユーザ登録インストール コンジットの表示名をセットします。
ImSetString ユーザ登録インストール コンジットの文字列コンフィグレーション エントリをセットします。
ImSetSystemDirectory システム登録インストール コンジットがインストールするファイルを探し出すディレクトリの名前をセットします。
ImSetSystemDWord システム登録インストール コンジットの DWORD コンフィグレーション エントリ値をセットします。
ImSetSystemExtension システム登録インストール コンジットによってサポートされるファイル拡張子をセットします。
ImSetSystemMask システム登録インストール コンジットのビット マスクの値をセットします。
ImSetSystemModule システム登録インストール コンジットのファイル名をセットします。
ImSetSystemName システム登録インストール コンジットの表示名をセットします。
ImSetSystemString システム登録インストール コンジットの文字列コンフィグレーション エントリをセットします。
ImUnregisterID 現在の Windows ユーザのために登録されているインストール コンジットの登録を解除します。
ImUnregisterSystemID システムのために登録されているインストール コンジットの登録を解除します。

ImGetDirectory 関数 ^TOP^

目的

ユーザ登録インストール コンジットがインストールするファイルを見つけ出すディレクトリの名前を取得します。

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImGetDirectory (
   DWORD dwID,
   TCHAR *pDirectory,
   int *piSize
)

パラメータ

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

返り値

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

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

  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_BUFFER_TOO_SMALL
    • あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、このかんすうは piSize に必要とされるサイズを返します。
  • ERR_VALUE_NOT_FOUND
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER

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

コメント

この関数は指定されたインストール コンジットの Directory コンフィグレーション エントリの値を取得します。ディレクトリ文字列はディレクトリを指定します。このディレクトリは、インストール コンジットがインストールするファイルを見つけ出す現在の HotSync ユーザのディレクトリ下にあります。例えば、Directory の値が Install であり、Core\Path の値が通常の値である場合、このインストール コンジットのディレクトリのフル パスは以下のようになります:

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

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

互換性

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

参照

Directory, ImSetDirectory()

ImGetDWord 関数 ^TOP^

目的

ユーザ登録インストール コンジットの DWORD コンフィグレーション エントリ値を取得します。

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImGetDWord (
   DWORD dwID,
   const TCHAR *pValue,
   DWORD *pdwValue,
   DWORD dwDefault
)

パラメータ

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

返り値

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

  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_VALUE_NOT_FOUND
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER

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

コメント

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

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

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

互換性

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

参照

ImSetDWord()

ImGetExtension 関数 ^TOP^

目的

ユーザ登録インストール コンジットによってサポートされるファイル拡張子を取得します。

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImGetExtension (
   DWORD dwID,
   TCHAR *pExtension,
   int *piSize
)

パラメータ

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

返り値

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

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

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

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

コメント

この関数は指定されたインストール コンジットの Extensions コンフィグレーション エントリの値を取得します。Extensions 文字列はインストール コンジットがサポートするファイル拡張子を指定します。

この関数は現在の Windows ユーザのために登録されているインストール コンジットについての情報を取得します。システムのために登録されているインストール コンジットがサポートするファイル拡張子を取得するには、ImGetSystemExtension() を呼び出します。

互換性

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

参照

Extensions, ImSetExtension()

ImGetMask 関数 ^TOP^

目的

ユーザ登録インストール コンジットのビット マスクの値を取得します。

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImGetMask (
   DWORD dwID,
   DWORD *pdwMask
)

パラメータ

  • → dwID
    • インストール コンジットの ID を指定する DWORD。あなたはこのインストール コンジットの Mask コンフィグレーション エントリの値を取得しようとしています。
  • ← pdwMask
    • DWORD へのポインタ。返り時には、これは指定されたインストール コンジットの Mask コンフィグレーション エントリの値になります。

返り値

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

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

  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_VALUE_NOT_FOUND
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER

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

コメント

この関数は指定されたインストール コンジットの Mask コンフィグレーション エントリの値を取得します。Mask はインストール コンジットを一意に識別するビット マスクです。

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

互換性

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

参照

Mask, ImSetMask(), C/C++ Sync Suite Companion「インストール コンジットの登録」

ImGetModule 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImGetModule (
   DWORD dwID,
   TCHAR *pModule,
   int *piSize
)

パラメータ

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

返り値

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

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

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

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

コメント

この関数は指定されたインストール コンジットの Module コンフィグレーション エントリの値を取得します。Module 文字列はインストール コンジットが呼び出されるときにロードされるインストール コンジット DLL のファイル名です。

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

互換性

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

参照

Module, ImSetModule()

ImGetName 関数 ^TOP^

目的

ユーザ登録インストール コンジットの表示名を取得します。

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImGetName (
   DWORD dwID,
   TCHAR *pConduitName,
   int *piSize
)

パラメータ

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

返り値

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

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

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

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

コメント

この関数は指定されたインストール コンジットの Name コンフィグレーション エントリの値を取得します。Name 文字列はインストール コンジットが HotSync マネージャの Custom ダイアログ ボックスに表示されるときの名前を指定します。

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

互換性

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

参照

Name, ImSetName()

ImGetString 関数 ^TOP^

目的

ユーザ登録インストール コンジットの文字列コンフィグレーション エントリを取得します。

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImGetString (
   DWORD dwID,
   const TCHAR *pValue,
   TCHAR *pString,
   int *piSize,
   const TCHAR *pDefault
)

パラメータ

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

返り値

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

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

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

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

コメント

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

インストール コンジット マネージャが pValue によって指定されたコンフィグレーション エントリ名を見つけられなかった場合、デフォルト値を返し (pStringpDefault の値をセットし)、0 を返します (成功したということ)。しかしながら、dwID によって指定されたインストール コンジットが存在しない場合、インストール コンジットはデフォルト値を返さず、エラーを返します。

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

互換性

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

参照

ImSetString()

ImGetSystemDirectory 関数 ^TOP^

目的

システム登録インストール コンジットがインストールするファイルを見つけ出すディレクトリの名前を取得します。

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImGetSystemDirectory (
   DWORD dwID,
   TCHAR *pDirectory,
   int *piSize
)

パラメータ

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

返り値

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

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

  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_BUFFER_TOO_SMALL
    • あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、このかんすうは piSize に必要とされるサイズを返します。
  • ERR_VALUE_NOT_FOUND
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER

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

コメント

この関数は指定されたインストール コンジットの Directory コンフィグレーション エントリの値を取得します。ディレクトリ文字列はディレクトリを指定します。このディレクトリは、インストール コンジットがインストールするファイルを見つけ出す現在の HotSync ユーザのディレクトリ下にあります。例えば、Directory の値が Install であり、Core\Path の値が通常の値である場合、このインストール コンジットのディレクトリのフル パスは以下のようになります:

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

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

互換性

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

参照

Directory, ImSetSystemDirectory()

ImGetSystemDWord 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImGetSystemDWord (
   DWORD dwID,
   const TCHAR *pValue,
   DWORD *pdwValue,
   DWORD dwDefault
)

パラメータ

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

返り値

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

  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_VALUE_NOT_FOUND
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER

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

コメント

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

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

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

互換性

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

参照

ImSetSystemDWord()

ImGetSystemExtension 関数 ^TOP^

目的

システム登録インストール コンジットによってサポートされるファイル拡張子を取得します。

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImGetSystemExtension (
   DWORD dwID,
   TCHAR *pExtension,
   int *piSize
)

パラメータ

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

返り値

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

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

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

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

コメント

この関数は指定されたインストール コンジットの Extensions コンフィグレーション エントリの値を取得します。Extensions 文字列はインストール コンジットがサポートするファイル拡張子を指定します。

この関数はシステムのために登録されているインストール コンジットについての情報を取得します。現在の Windows ユーザのために登録されているインストール コンジットがサポートするファイル拡張子を取得するには、ImGetExtension() を呼び出します。

互換性

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

参照

Extensions, ImSetSystemExtension()

ImGetSystemMask 関数 ^TOP^

目的

システム登録インストール コンジットのビット マスクの値を取得します。

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImGetSystemMask (
   DWORD dwID,
   DWORD *pdwMask
)

パラメータ

  • → dwID
    • インストール コンジットの ID を指定する DWORD。あなたはこのインストール コンジットの Mask コンフィグレーション エントリの値を取得しようとしています。
  • ← pdwMask
    • DWORD へのポインタ。返り時には、これは指定されたインストール コンジットの Mask コンフィグレーション エントリの値になります。

返り値

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

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

  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_VALUE_NOT_FOUND
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER

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

コメント

この関数は指定されたインストール コンジットの Mask コンフィグレーション エントリの値を取得します。Mask はインストール コンジットを一意に識別するビット マスクです。

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

互換性

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

参照

Mask, ImSetSystemMask(), C/C++ Sync Suite Companion「インストール コンジットの登録」

ImGetSystemModule 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImGetSystemModule (
   DWORD dwID,
   TCHAR *pModule,
   int *piSize
)

パラメータ

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

返り値

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

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

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

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

コメント

この関数は指定されたインストール コンジットの Module コンフィグレーション エントリの値を取得します。Module 文字列はインストール コンジットが呼び出されるときにロードされるインストール コンジット DLL のファイル名です。

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

互換性

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

参照

Module, ImSetSystemModule()

ImGetSystemName 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImGetSystemName (
   DWORD dwID,
   TCHAR *pConduitName,
   int *piSize
)

パラメータ

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

返り値

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

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

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

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

コメント

この関数は指定されたインストール コンジットの Name コンフィグレーション エントリの値を取得します。Name 文字列はインストール コンジットが HotSync マネージャの Custom ダイアログ ボックスに表示されるときの名前を指定します。

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

互換性

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

参照

Name, ImSetSystemName()

ImGetSystemString 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImGetSystemString (
   DWORD dwID,
   const TCHAR *pValue,
   TCHAR *pString,
   int *piSize,
   const TCHAR *pDefault
)

パラメータ

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

返り値

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

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

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

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

コメント

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

インストール コンジット マネージャが pValue によって指定されたコンフィグレーション エントリ名を見つけられなかった場合、デフォルト値を返し (pStringpDefault の値をセットし)、0 を返します (成功したということ)。しかしながら、dwID によって指定されたインストール コンジットが存在しない場合、インストール コンジットはデフォルト値を返さず、エラーを返します。

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

互換性

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

参照

ImSetSystemString()

ImRegister 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImRegister (
   const FileInstallType sConduitInfo
)

パラメータ

  • → sConduitInfo
    • インストール コンジットを登録するための情報を指定する FileInstallType 構造体。

返り値

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

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

  • ERR_CONDUIT_MGR
  • ERR_CONFLICTING_EXTENSION
    • 指定されたファイル拡張子はすでの他のインストール コンジットで登録されています。
  • ERR_NO_MEMORY
  • ERR_INSTALL_ID_ALREADY_IN_USE
  • ERR_STORAGE_ACCESS
  • ERR_UNABLE_TO_CREATE_CONDUIT
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_INSTALL_ID

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

コメント

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

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

互換性

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

参照

FileInstallType, ImRegisterID(), ImUnregisterID()

ImRegisterID 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImRegisterID (
   DWORD dwCreatorID
)

パラメータ

  • → dwCreatorID
    • インストール コンジットの固有 ID を指定する DWORD (FileInstallType.dwCreatorID フィールドで定義されているのと同じ値)。

返り値

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

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

  • ERR_INSTALL_ID_ALREADY_IN_USE
  • ERR_STORAGE_ACCESS
  • ERR_UNABLE_TO_CREATE_CONDUIT
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_INSTALL_ID

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

コメント

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

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

参照

FileInstallType, ImRegister(), ImUnregisterID()

ImRegisterSystem 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImRegisterSystem (
   const FileInstallType sConduitInfo
)

パラメータ

  • → sConduitInfo
    • インストール コンジットを登録するための情報を指定する FileInstallType 構造体。

返り値

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

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

  • ERR_CONDUIT_MGR
  • ERR_CONFLICTING_EXTENSION
    • 指定されたファイル拡張子はすでの他のインストール コンジットで登録されています。
  • ERR_NO_MEMORY
  • ERR_INSTALL_ID_ALREADY_IN_USE
  • ERR_STORAGE_ACCESS
  • ERR_UNABLE_TO_CREATE_CONDUIT
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_INSTALL_ID

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

コメント

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

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

互換性

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

参照

FileInstallType, ImRegisterSystemID(), ImUnregisterSystemID()

ImRegisterSystemID 関数 ^TOP^

目的

インストール コンジットの新しい固有 ID をシステムのために HotSync マネージャに登録します (登録を完了するには他の ImSetSystem...()) 関数を呼び出すことが必要です。

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImRegisterSystemID (
   DWORD dwCreatorID
)

パラメータ

  • → dwCreatorID
    • インストール コンジットの固有 ID を指定する DWORD (FileInstallType.dwCreatorID フィールドで定義されているのと同じ値)。

返り値

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

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

  • ERR_INSTALL_ID_ALREADY_IN_USE
  • ERR_STORAGE_ACCESS
  • ERR_UNABLE_TO_CREATE_CONDUIT
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_INSTALL_ID

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

コメント

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

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

参照

FileInstallType, ImRegisterSystem(), ImUnregisterSystemID()

ImSetDirectory 関数 ^TOP^

目的

ユーザ登録インストール コンジットがインストールするファイルを探し出すディレクトリの名前をセットします。

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImSetDirectory (
   DWORD dwID,
   const TCHAR *pDirectory
)

パラメータ

  • → dwID
    • インストール コンジットの ID を指定する DWORD。あなたはこのインストール コンジットのコンフィグレーション エントリ値をセットしようとしています。
  • → pDirectory
    • 指定されたインストール コンジットの Directory コンフィグレーション エントリの値を指定する null で終了する文字バッファへのポインタ。

返り値

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

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

  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER

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

コメント

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

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

この関数は現在の Windows ユーザのために登録されているインストール コンジットについての情報をセットします。システムのために登録されているインストール コンジットのディレクトリをセットするには、ImSetSystemDirectory() を呼び出します。

互換性

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

参照

Directory, ImGetDirectory()

ImSetDWord 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImSetDWord (
   DWORD dwID,
   const TCHAR *pValue,
   DWORD dwValue
)

パラメータ

  • → dwID
    • インストール コンジットの ID を指定する DWORD。あなたはこのインストール コンジットのコンフィグレーション エントリ値をセットしようとしています。
  • → pValue
    • コンフィグレーション エントリの文字列名を保持している null で終了する文字バッファへのポインタ。
  • → dwValue
    • あなたが指定されたコンフィグレーション エントリにセットしようとしている値。

返り値

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

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

  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER
  • ERR_VALUE_NOT_FOUND

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

コメント

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

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

互換性

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

参照

ImGetDWord()

ImSetExtension 関数 ^TOP^

目的

ユーザ登録インストール コンジットによってサポートされるファイル拡張子をセットします。

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImSetExtension (
   DWORD dwID,
   const TCHAR *pExtension
)

パラメータ

  • → dwID
    • インストール コンジットの ID を指定する DWORD。あなたはこのインストール コンジットの Extension 値をセットしようとしています。
  • → pExtension
    • 指定されたインストール コンジットの Extenstions コンフィグレーション エントリの値を指定する null で終了する文字バッファへのポインタ。

返り値

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

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

  • ERR_NO_CONDUIT
  • ERR_CONFLICTING_EXTENSION
    • 指定されたファイル拡張子はすでに他のインストール コンジットで登録されています。
  • ERR_STORAGE_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER

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

コメント

この関数は指定されたインストール コンジットの Extensions コンフィグレーション エントリの値をセットします。Extensions 文字列はインストール コンジットがサポートするファイル拡張子を指定します。

この関数は現在の Windows ユーザのために登録されているインストール コンジットについての情報をセットします。システムのために登録されているインストール コンジットがサポートするファイル拡張子をセットするには、ImSetSystemExtension() を呼び出します。

互換性

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

参照

ImGetExtension()

ImSetMask 関数 ^TOP^

目的

ユーザ登録インストール コンジットのビット マスクの値をセットします。

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImSetMask (
   DWORD dwID,
   DWORD dwMask
)

パラメータ

  • → dwID
    • インストール コンジットの ID を指定する DWORD。あなたはこのインストール コンジットのビット マスクの値をセットしようとしています。
  • → dwMask
    • あなたが指定されたインストール コンジットの Mask コンフィグレーション エントリにセットしようとしている DWord 値。

返り値

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

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

  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER

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

コメント

この関数は指定されたインストール コンジットの Mask コンフィグレーション エントリの値をセットします。Mask はインストール コンジットを一意に識別するビット マスク値です。

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

互換性

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

参照

Mask, ImGetMask(), C/C++ Sync Suite Companion「インストール コンジットの登録」

ImSetModule 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImSetModule (
   DWORD dwID,
   const TCHAR *pModule
)

パラメータ

  • → dwID
    • インストール コンジットの ID を指定する DWORD。あなたはこのインストール コンジットの Module 値をセットしようとしています。
  • → pModule
    • 指定されたインストール コンジットの Module コンフィグレーション エントリの値を指定する null で終了する文字バッファへのポインタ。

返り値

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

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

  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER

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

コメント

この関数は指定されたインストール コンジットの Module コンフィグレーション エントリの値をセットします。Module 文字列はインストール コンジットが呼び出されるときにロードされるインストール コンジット DLL のファイル名です。

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

互換性

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

参照

Module, ImGetModule()

ImSetName 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImSetName (
   DWORD dwID,
   const TCHAR *pConduitName
)

パラメータ

  • → dwID
    • インストール コンジットの ID を指定する DWORD。あなたはこのインストール コンジットの Name 値をセットしようとしています。
  • → pConduitName
    • 指定されたインストール コンジットの Name コンフィグレーション エントリの値を指定する null で終了する文字バッファへのポインタ。

返り値

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

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

  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER

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

コメント

この関数は指定されたインストール コンジットの Name コンフィグレーション エントリの値をセットします。Name 文字列は HotSync マネージャの Custom ダイアログ ボックスに表示されるインストール コンジットの名前を指定します。

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

互換性

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

参照

Name, ImGetName()

ImSetString 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImSetString (
   DWORD dwID,
   const TCHAR *pValue,
   TCHAR *pString
)

パラメータ

  • → dwID
    • インストール コンジットの ID を指定する DWORD。あなたはこのインストール コンジットのコンフィグレーション エントリ値をセットしようとしています。
  • → pValue
    • コンフィグレーション エントリの文字列名を保持している null で終了する文字バッファへのポインタ。
  • → pString
    • あなたが指定されたコンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER
  • ERR_VALUE_NOT_FOUND

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

コメント

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

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

互換性

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

参照

ImGetString()

ImSetSystemDirectory 関数 ^TOP^

目的

システム登録インストール コンジットがインストールするファイルを探し出すディレクトリの名前をセットします。

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImSetSystemDirectory (
   DWORD dwID,
   const TCHAR *pDirectory
)

パラメータ

  • → dwID
    • インストール コンジットの ID を指定する DWORD。あなたはこのインストール コンジットのコンフィグレーション エントリ値をセットしようとしています。
  • → pDirectory
    • 指定されたインストール コンジットの Directory コンフィグレーション エントリの値を指定する null で終了する文字バッファへのポインタ。

返り値

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

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

  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER

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

コメント

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

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

この関数はシステムのために登録されているインストール コンジットについての情報をセットします。現在の Windows ユーザのために登録されているインストール コンジットのディレクトリをセットするには、ImSetDirectory() を呼び出します。

互換性

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

参照

Directory, ImGetSystemDirectory()

ImSetSystemDWord 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImSetSystemDWord (
   DWORD dwID,
   const TCHAR *pValue,
   DWORD dwValue
)

パラメータ

  • → dwID
    • インストール コンジットの ID を指定する DWORD。あなたはこのインストール コンジットのコンフィグレーション エントリ値をセットしようとしています。
  • → pValue
    • コンフィグレーション エントリの文字列名を保持している null で終了する文字バッファへのポインタ。
  • → dwValue
    • あなたが指定されたコンフィグレーション エントリにセットしようとしている値。

返り値

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

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

  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER
  • ERR_VALUE_NOT_FOUND

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

コメント

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

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

互換性

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

参照

ImGetSystemDWord()

ImSetSystemExtension 関数 ^TOP^

目的

システム登録インストール コンジットによってサポートされるファイル拡張子をセットします。

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImSetSystemExtension (
   DWORD dwID,
   const TCHAR *pExtension
)

パラメータ

  • → dwID
    • インストール コンジットの ID を指定する DWORD。あなたはこのインストール コンジットの Extension 値をセットしようとしています。
  • → pExtension
    • 指定されたインストール コンジットの Extenstions コンフィグレーション エントリの値を指定する null で終了する文字バッファへのポインタ。

返り値

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

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

  • ERR_NO_CONDUIT
  • ERR_CONFLICTING_EXTENSION
    • 指定されたファイル拡張子はすでに他のインストール コンジットで登録されています。
  • ERR_STORAGE_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER

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

コメント

この関数は指定されたインストール コンジットの Extensions コンフィグレーション エントリの値をセットします。Extensions 文字列はインストール コンジットがサポートするファイル拡張子を指定します。

この関数はシステムのために登録されているインストール コンジットについての情報をセットします。現在の Windows ユーザのために登録されているインストール コンジットがサポートするファイル拡張子をセットするには、ImSetExtension() を呼び出します。

互換性

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

参照

Extensions, ImGetSystemExtension()

ImSetSystemMask 関数 ^TOP^

目的

システム登録インストール コンジットのビット マスクの値をセットします。

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImSetSystemMask (
   DWORD dwID,
   DWORD dwMask
)

パラメータ

  • → dwID
    • インストール コンジットの ID を指定する DWORD。あなたはこのインストール コンジットのビット マスクの値をセットしようとしています。
  • → dwMask
    • あなたが指定されたインストール コンジットの Mask コンフィグレーション エントリにセットしようとしている DWord 値。

返り値

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

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

  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER

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

コメント

この関数は指定されたインストール コンジットの Mask コンフィグレーション エントリの値をセットします。Mask はインストール コンジットを一意に識別するビット マスク値です。

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

互換性

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

参照

Mask, ImGetSystemMask(), C/C++ Sync Suite Companion「インストール コンジットの登録」

ImSetSystemModule 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImSetSystemModule (
   DWORD dwID,
   const TCHAR *pModule
)

パラメータ

  • → dwID
    • インストール コンジットの ID を指定する DWORD。あなたはこのインストール コンジットの Module 値をセットしようとしています。
  • → pModule
    • 指定されたインストール コンジットの Module コンフィグレーション エントリの値を指定する null で終了する文字バッファへのポインタ。

返り値

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

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

  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER

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

コメント

この関数は指定されたインストール コンジットの Module コンフィグレーション エントリの値をセットします。Module 文字列はインストール コンジットが呼び出されるときにロードされるインストール コンジット DLL のファイル名です。

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

互換性

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

参照

Module, ImGetSystemModule()

ImSetSystemName 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImSetSystemName (
   DWORD dwID,
   const TCHAR *pConduitName
)

パラメータ

  • → dwID
    • インストール コンジットの ID を指定する DWORD。あなたはこのインストール コンジットの Name 値をセットしようとしています。
  • → pConduitName
    • 指定されたインストール コンジットの Name コンフィグレーション エントリの値を指定する null で終了する文字バッファへのポインタ。

返り値

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

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

  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_UNABLE_TO_SET_CONDUIT_VALUE
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER

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

コメント

この関数は指定されたインストール コンジットの Name コンフィグレーション エントリの値をセットします。Name 文字列は HotSync マネージャの Custom ダイアログ ボックスに表示されるインストール コンジットの名前を指定します。

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

互換性

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

参照

Name, ImGetSystemName()

ImSetSystemString 関数 ^TOP^

目的

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

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImSetSystemString (
   DWORD dwID,
   const TCHAR *pValue,
   TCHAR *pString
)

パラメータ

  • → dwID
    • インストール コンジットの ID を指定する DWORD。あなたはこのインストール コンジットのコンフィグレーション エントリ値をセットしようとしています。
  • → pValue
    • コンフィグレーション エントリの文字列名を保持している null で終了する文字バッファへのポインタ。
  • → pString
    • あなたが指定されたコンフィグレーション エントリにセットしようとしている文字列値。

返り値

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

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

  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_INVALID_INSTALL_ID
  • ERR_INVALID_POINTER
  • ERR_VALUE_NOT_FOUND

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

コメント

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

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

互換性

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

参照

ImGetSystemString()

ImUnregisterID 関数 ^TOP^

目的

現在の Windows ユーザのために登録されているインストール コンジットの登録を解除します。

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImUnregisterID (
   DWORD dwCreatorID
)

パラメータ

  • → dwCreatorId
    • 登録を解除するインストール コンジットの ID を指定する DWord

返り値

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

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

  • ERR_UNABLE_TO_DELETE
  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_INVALID_INSTALL_ID

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

コメント

インストール コンジットの ID を与えられると、この関数はそのインストール コンジットの登録を解除します - これによりそのインストール コンジットのすべてのコンフィグレーション エントリは削除されます。

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

互換性

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

参照

ImRegister(), ImRegisterID()

ImUnregisterSystemID 関数 ^TOP^

目的

システムのために登録されているインストール コンジットの登録を解除します。

宣言されている場所

CondMgr.h

Prototype

int WINAPI ImUnregisterSystemID (
   DWORD dwCreatorID
)

パラメータ

  • → dwCreatorId
    • 登録を解除するインストール コンジットの ID を指定する DWord

返り値

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

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

  • ERR_UNABLE_TO_DELETE
  • ERR_NO_CONDUIT
  • ERR_STORAGE_ACCESS
  • ERR_INVALID_INSTALL_ID

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

コメント

インストール コンジットの ID を与えられると、この関数はそのインストール コンジットの登録を解除します - これによりそのインストール コンジットのすべてのコンフィグレーション エントリは削除されます。

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

互換性

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

参照

ImRegisterSystem(), ImRegisterSystemID()

← 11 章に戻る ↑トップへ 13 章に進む →