Palm Programmer's Laboratory

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

C/C++ Sync Suite Reference601/15

←　14 章に戻る　↑トップへ　16 章に進む　→

15 インストール援助機能 API

インストール援助機能はあなたのデスクトップ アプリケーションやインストーラが Palm OS データベース (アプリケーションを含む) をハンドヘルドのメイン メモリやハンドヘルドの拡張スロットの中に存在するカードにインストールすることを可能にします。これらのことと他の操作を実行するために、インストール援助機能は以下のことを行います:

  • あなたがインストールしたいファイルの拡張子に基づいて実行するインストール コンジットを選択します。例えば通常、.prc, .pdb, .pnc 拡張子はそれらの拡張子を持つファイルをデータベースとしてハンドヘルドのメイン メモリにインストールするデフォルト インストール コンジットで登録されています。それに対して、他のインストール コンジットはいずれかのファイル タイプ (*.*) を拡張カードにインストールするために登録されているかもしれません。
  • ファイルをデスクトップ コンピュータ上の適切なディレクトリにコピーします。
  • HotSync マネージャに次の同期で適切なインストール コンジット (これはインストールされるファイル タイプを処理するために登録されたもの) を実行するよう知らせるフラグをセットします。

次にユーザが同期を行うとき、HotSync マネージャはファイルをハンドヘルドとデスクトップ間で転送する適切なインストール コンジットを実行します。

インストール援助機能関数は InstAide.dll の中で利用可能であり、InstAide.h の中で宣言されています。インストール援助機能についての更なる情報は、C/C++ Sync Suite Companion の を参照してください。

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

インストール援助機能 API バージョン ^TOP^

インストール援助機能 API は新しい関数と既存の関数の新しいバージョンを持つよう発展し続けます。バージョン 4.0 からは、インストール援助機能 API の各バージョンはメジャ バージョン番号とマイナ バージョン番号を持つようになりました。あなたはインストール援助機能 API バージョン 4.0 以降で利用可能な PlmGetLibVersion() 関数を呼び出すことによってあなたが使用しているインストール援助機能 API のバージョンを決定することができます。それ以前のバージョンは PlmGetLibVersion() 関数を持ちません - このことはバージョン 4.0 以降の機能が存在しないことを示します。

インストール援助 API はメジャ バージョン内で下位互換性を維持します。マイナ バージョン番号は新しい関数が追加されるかバグが修正されたときに変更されます。このドキュメントは各関数のバージョン情報を含みます。

あなたのアプリケーションがある特定のバージョンのインストール援助機能 API でのみ利用可能な関数に依存する場合、あなたはインストール中にあなたが扱っているインストール援助機能 API のバージョンを決定する必要があります。そうするには、PlmGetLibVersion() 関数を呼び出します。この関数はデスクトップ コンピュータ上にあるインストール援助機能 API のメジャ バージョン番号とマイナ バージョン番号の両方を返します。

例えば、あなたのアプリケーションがインストール援助機能 API のバージョン 4.0 で追加された関数に依存する場合、あなたは PlmGetLibVersion() を呼び出して、メジャ バージョン番号が 4 でありマイナ バージョン番号が 0 以上であることを検証する必要があります。

インストール援助機能 API の新しい Feature とその他の変更についての要約は、付録 A 「改定履歴」 を参照してください。

インストール援助機能構造体 ^TOP^

この節では、インストール援助機能 API で使用される FileInstallType データ構造体について説明します。

FileInstallType 構造体 ^TOP^

目的

インストール コンジットについての情報を受け取ります。この情報はコンジット コンフィグレーション エントリの中に保存されていて、PltGetInstallConduitInfo() と PltGetInstallCreatorInfo() によって取得されます。

宣言されている場所

InstAide.h

Prototype

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

フィールド

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

コメント

この構造体のフィールドに対応するコンフィグレーション エントリの詳細については、「インストール コンジット コンフィグレーション エントリ」 を参照してください。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

PltGetInstallConduitInfo(), PltGetInstallCreatorInfo()

インストール援助機能定数 ^TOP^

この節では、あなたがインストール援助機能 API で使用する以下のグループのプロセッサ定数について説明します。

定数 説明
パス定義 PltSetPath() と PltGetInstallFileFilter() でセットまたは取得するパスを定義します。
構造体のサイズ インストール援助機能によって使用される構造体のサイズを定義します。
インストール援助機能 API のバージョン PlmGetLibVersion() が返すインストール援助機能 API のバージョンを定義します。

パス定義 ^TOP^

目的

PltSetPath() と PltGetInstallFileFilter() でセットまたは取得するパスを定義します。

宣言されている場所

InstAide.h

定数

  • #define PILOT_PATH_HOME 1
    • デスクトップ コンピュータ上のユーザ ディレクトリへのパス - 例えば、C:\Documents and Settings\<WinUsername>\My Documents\Palm OS Desktop。この値は Core\Path コンフィグレーション エントリに対応します。
  • #define PILOT_PATH_HOTSYNC 2
    • HotSync マネージャ実行形式ファイルのフル パスとファイル名 - 例えば、C:\Program Files\PalmSource\Desktop\hotsync.exe。この値は Core\HotSyncPath コンフィグレーション エントリに対応します。
  • #define PILOT_PATH_TUTORIAL 3
    • この定数はインストール援助機能では使用されません。
  • #define PILOT_PATH_MAX PILOT_PATH_TUTORIAL
    • sPathType パラメータが PltSetPath() と PltGetInstallFileFilter() の中で持つことができる最大値。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

PltSetPath(), PltGetInstallFileFilter()

構造体のサイズ ^TOP^

目的

インストール援助機能によって使用される構造体のサイズを定義します。

宣言されている場所

InstAide.h

定数

  • #define FILEINSTALLTYPE_SIZE sizeof(FileInstallType)

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

FileInstallType

インストール援助機能 API のバージョン ^TOP^

目的

PlmGetLibVersion() が返すインストール援助機能 API のバージョンを定義します。

宣言されている場所

InstAide.h

定数

  • #define INSTAIDE_LIB_VER_MAJOR 4
    • メジャ バージョン番号を示します。
  • #define INSTAIDE_LIB_VER_MINOR 1
    • マイナ バージョン番号を示します。

コメント

インストール援助機能 API のバージョン 4.1 以降は PlmGetLibVersion() が返すこれらの値を定義します。バージョン 4.0 は PlmGetLibVersion() が利用可能な最初のバージョンであり、これらの定数は定義されていませんでした。しかしながら、PlmGetLibVersion() はメジャ バージョン番号として 4 を、マイナ バージョン番号として 0 を返します。

互換性

  • インストール援助機能バージョン: 4.1 以降
  • Palm OS バージョン: すべて

参照

PlmGetLibVersion()

インストール援助機能関数 ^TOP^

この節では、以下の関数について説明します。アプリケーションやコンジットはファイルまたはデータベースをハンドヘルドまたは拡張カードにインストールするためにこれらの関数を使用することができます。

関数 説明
PlmGetLibVersion() インストール援助機能 API のバージョンを取得します。
PlmGetUserIDFromName() 指定された文字列ユーザ名に対応する DWORD ユーザ ID を取得します。
PlmGetUserNameFromID() 指定された DWORD ユーザ ID に対する文字列ユーザ名を取得します。
PlmMoveInstallFileToHandheld() すでに拡張スロットの中にある補助記憶装置にインストールするためにキューに追加されているファイルのインストール先をユーザのハンドヘルドの主記憶装置に変更します。
PlmMoveInstallFileToSlot() すでにユーザのハンドヘルドの主記憶装置にインストールするためにキューに追加されているファイルのインストール先を拡張スロットの中にある補助記憶装置に変更します。
PlmSlotGetFileCount() 指定されたスロットにインストールするためにキューに追加されている指定されたユーザのためのファイルの数を取得します。
PlmSlotGetFileInfo() 指定されたスロット インストール ディレクトリの中にある指定されたユーザのためのファイル名とファイル サイズを返します。
PlmSlotInstallFile() ユーザのハンドヘルドの拡張カードの中にある補助記憶装置にインストールするためにファイルをキューに追加します。
PlmSlotMoveInstallFile() ユーザのハンドヘルドの拡張スロットの中にある補助記憶装置にインストールするためにすでにキューに追加されているファイルのインストール先をある拡張スロットから他の拡張スロットに変更します。
PlmSlotRemoveInstallFile() ユーザのハンドヘルドの拡張スロットの中にある補助記憶装置にインストールするファイルのキューからファイルを削除します。
PltGetFileCount() ユーザのハンドヘルド インストール ディレクトリの中に指定されたタイプのファイルがいくつあるかを決定します。
PltGetFileInfo() 指定されたユーザの指定されたハンドヘルド インストール ディレクトリの中にあるファイルについての情報を返します。
PltGetFileName() ファイル タイプとファイルのインデックスに基づき、指定されたユーザの指定されたハンドヘルド インストール ディレクトリの中にあるファイルの名前を取得します。
PltGetFileTypeExtension() サポートされるファイル タイプ拡張子を取得します。
PltGetFileTypesCount() すべてのインストール コンジットのために HotSync マネージャに登録されているファイル タイプの数を返します。
PltGetInstallConduitCount() HotSync マネージャに登録されているインストール コンジットの数を返します。
PltGetInstallConduitInfo() インデックスによって指定されたインストール コンジットについての情報を取得します。
PltGetInstallCreatorInfo() 固有 ID によって指定されたインストール コンジットについての情報を取得します。
PltGetInstallFileFilter() デスクトップ コンピュータ上のすべてのインストール コンジットのためのすべてのファイル フィルタを取得し、フィルタ文字列を返される 1 つの文字列に連結します。
PltGetInstallFileFilterForUser() デスクトップ コンピュータ上の指定されたユーザのためのすべてのインストール コンジットのためのすべてのファイル フィルタを取得し、フィルタ文字列を返される 1 つ文字列に連結します。
PltGetPath() 定義されている Palm OS Desktop パス変数の 1 つの値を取得します。
PltGetRegistryPath() HotSync コンフィグレーション エントリへのパスを取得します。
PltGetUser() ユーザ データ ファイルの中に保存されている i 番目のユーザの名前を取得します。
PltGetUserCount() デスクトップ コンピュータ上のユーザ データ ファイルの中で定義されているユーザの数を返します。
PltGetUserDirectory() 指定されたユーザ ディレクトリへのフル パスを取得します。
PltInstallFile() ユーザのハンドヘルド上の主記憶装置にインストールするためにファイルをキューに追加します。
PltIsInstallMaskSet() 指定されたインストール コンジットが指定されたユーザのために次の HotSync の最中に実行されるようセットされているかどうかを決定します。
PltIsUserProfile() アカウントがユーザ プロファイルであるかどうかを決定します。
PltRemoveInstallFile() ユーザのハンドヘルドの主記憶装置にインストールするファイルのキューからファイルを削除します。
PltRemoveInstallRegistry() PltSetInstallRegistry() によってセットされたインストール コンジット設定を削除します。
PltResetInstallMask() 指定されたインストール コンジット - 指定されたユーザのために次の HotSync の最中に実行されるよう選択されていた - の選択を解除します。
PltSetInstallRegistry() インストール コンジット情報をデフォルト値に戻します。
PltSetPath() Palm OS Desktop パス変数の 1 つの値をセットします。

PlmGetLibVersion 関数 ^TOP^

目的

インストール援助機能 API のバージョンを取得します。

宣言されている場所

InstAide.h

Prototype

int PlmGetLibVersion (
   DWORD *pdwMajor,
   DWORD *pdwMinor
)

パラメータ

  • ← pdwMajor
    • メジャ バージョン番号。これは INSTAIDE_LIB_VER_MAJOR によって定義されます。
  • ← pdwMinor
    • マイナ バージョン番号。これは INSTAIDE_LIB_VER_MINOR によって定義されます。

返り値

常に 0 を返します。

コメント

インストール援助機能 API の関数を呼び出す前にあなたが使用しているインストール援助機能 API のバージョンを決定するために PlmGetLibVersion() を呼び出します。更なる情報は、「インストール援助機能 API バージョン」 を参照してください。バージョン間で何が変更されたかについての詳細は、付録 A 「改定履歴」 を参照してください。

この関数によって返されるバージョン番号定数は 「インストール援助機能 API のバージョン」 で定義されています。

互換性

  • インストール援助機能バージョン: 4.0 以降
  • Palm OS バージョン: すべて

PlmGetUserIDFromName 関数 ^TOP^

目的

指定された文字列ユーザ名に対する DWORD ユーザ ID を取得します。

宣言されている場所

InstAide.h

Prototype

int PlmGetUserIDFromName (
   TCHAR *pUser,
   DWORD *pdwID
)

パラメータ

  • → pUser
    • ユーザ名文字列。
  • ← pdwID
    • 返り時に、ユーザ ID。

返り値

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

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

ユーザ ID は指定されたユーザ名のために内部的に使用されます。

NOTE
デスクトップ上のユーザについての情報にアクセスするには、インストール援助機能 API の代わりに ユーザ データ API を使用することを PalmSource 社は推奨します。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID()

PlmGetUserNameFromID 関数 ^TOP^

目的

指定された DWORD ユーザ ID に対する文字列ユーザ名を取得します。

宣言されている場所

InstAide.h

Prototype

int PlmGetUserNameFromID (
   DWORD dwID,
   TCHAR *pUserBuffer,
   short *psUserBufSize
)

パラメータ

  • → dwID
    • ユーザ ID。
  • ← pUserBuffer
    • 文字バッファへのポインタ。返り時に、このポインタはユーザ名を保持します。
  • ← psUserBufSize
    • pUserBuffer パラメータによって参照される文字バッファのサイズ (TCHAR の数) を指定する short 整数値。返り時には、この値は pUserBuffer パラメータによって参照されるバッファに保存された TCHAR の実際の数になります。

返り値

成功した場合、pUserBuffer によって参照されるバッファに実際に書き込まれた TCHAR の数を指定する整数値を返します。

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

ユーザ ID は指定されたユーザ名のために内部的に使用されます。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserName()

PlmMoveInstallFileToHandheld 関数 ^TOP^

目的

拡張カードの中にある補助記憶装置にインストールするためにすでキューに追加されているファイルのインストール先をユーザのハンドヘルドの主記憶装置に変更します。

宣言されている場所

InstAide.h

Prototype

int PlmMoveInstallFileToHandheld (
   DWORD dwUserId,
   DWORD dwSlotIdFrom,
   const TCHAR *pszFileName
)

パラメータ

  • → dwUserId
    • ユーザの ID。
  • → dwSlotIdFrom
    • ソース スロット (ここからファイルのインストール先を移動します) のID。ファイルは現在このスロットのスロット インストール ディレクトリの中に存在しています。
  • → pszFileName
    • 移動されるファイルのファイル名だけ (パスは含みません) を保持している文字バッファへのポインタ。

返り値

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

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

  • ERR_PILOT_INVALID_FILENAME
  • ERR_PILOT_INVALID_PATH
  • ERR_PALM_FILE_MOVE_FAILED

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PlmMoveInstallFileToHandheld() はデスクトップ コンピュータ上のファイルを指定されたスロット インストール ディレクトリから関連付けされているハンドヘルド インストール ディレクトリ - つまり、指定されたタイプのファイルを扱うよう登録されているインストール コンジットに関連付けされているディレクトリ - に移動させます。この関数はインストール コンジットに登録されているファイル タイプ - 例えば、.prc ファイル タイプが HotSync マネージャとともに出荷される Install Conduit に登録されています - だけを受け付けます。そのため、この関数はそのようなファイルをユーザのハンドヘルド インストール ディレクトリに移動させることができます。

スロット ID を取得するには、ユーザ データ API の UmSlotGetInfo() 関数を使用します。

例

int retval = PlmMoveInstallFileToHandheld (dwUserId,
   dwSlotIdFrom, "SummitSch.pdb");

互換性

  • インストール援助機能バージョン: 4.0 以降
  • Palm OS バージョン: 4.0 以降

参照

UmSlotGetInfo(), PlmMoveInstallFileToSlot(), PlmSlotMoveInstallFile()

PlmMoveInstallFileToSlot 関数 ^TOP^

目的

ユーザのハンドヘルドの主記憶装置にインストールするためにすでにキューに追加されているファイルのインストール先を拡張スロットの中にある補助記憶装置に変更します。

宣言されている場所

InstAide.h

Prototype

int PlmMoveInstallFileToSlot (
   DWORD dwUserId,
   const TCHAR *pszFileName,
   DWORD dwSlotIdTo
)

パラメータ

  • → dwUserId
    • ユーザの ID。
  • → pszFileName
    • 移動するファイルのファイル名だけ (パスは含みません) を保持している文字バッファへのポインタ。
  • → dwSlotIdTo
    • インストール先となるスロット (ファイルのインストール先はここに変更されます) の ID。ファイルはこのスロットのインストール ディレクトリに移動させられます。

返り値

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

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

  • ERR_PILOT_INVALID_FILENAME
  • ERR_PILOT_INVALID_PATH
  • ERR_PALM_FILE_MOVE_FAILED

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PlmMoveInstallFileToSlot() はデスクトップ

PlmMoveInstallFileToSlot() はデスクトップ コンピュータ上のファイルを関連付けされているハンドヘルド インストール ディレクトリ -つまり、特定のタイプのファイルを扱うよう登録されているインストール コンジットに関連付けされているディレクトリ - からしていされたスロット インストール ディレクトリへ移動させます。この関数はインストール コンジットに登録されているファイル タイプ - 例えば、.prc ファイル タイプが HotSync マネージャとともに出荷されるインストール コンジットに登録されています - だけを受け付けます。そのため、この関数はそのようなファイルをユーザのスロット インストール ディレクトリに移動させることができます。

スロット ID を取得するには、ユーザ データ API の UmSlotGetInfo() 関数を使用します。

例

int retval = PlmMoveInstallFileToSlot (dwUserId,
   "SummitSch.pdb", dwSlotIdTo);

互換性

  • インストール援助機能バージョン: 4.0 以降
  • Palm OS バージョン: 4.0 以降

参照

UmSlotGetInfo(), PlmMoveInstallFileToHandheld(), PlmSlotMoveInstallFile()

PlmSlotGetFileCount 関数 ^TOP^

目的

指定されたスロットにインストールするためにキューに追加されている指定されたユーザのためのファイルの数を取得します。

宣言されている場所

InstAide.h

Prototype

int PlmSlotGetFileCount (
   DWORD dwUserId,
   DWORD dwSlotId,
   long *plFileCount
)

パラメータ

  • → dwUserId
    • ユーザの ID。
  • → dwSlotId
    • スロットの ID。このスロットのためにキューに追加されているファイル数を返します。
  • ← plFileCount
    • ファイルの数へのポインタ。

返り値

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

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

  • ERR_PILOT_INVALID_FILENAME
  • ERR_PILOT_INVALID_PATH
  • ERR_PALM_FILE_MOVE_FAILED

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PlmSlotGetFileCount() は指定されたユーザのための指定されたスロット インストール ディレクトリの中にあるすべてのファイルの数を決定します。このディレクトリは次の HotSync の最中にハンドヘルド上の指定された拡張スロットにインストールされるすべてのファイルを保持しています。

例

long nFileCount;
int retval = PlmSlotGetFileCount (dwUserId, dwSlotId,
   &nFileCount);

互換性

  • インストール援助機能バージョン: 4.0 以降
  • Palm OS バージョン: 4.0 以降

参照

PltGetFileCount()

PlmSlotGetFileInfo 関数 ^TOP^

目的

指定されたスロット インストール ディレクトリの中にある指定されたユーザのためのファイル名とファイル サイズを返します。

宣言されている場所

InstAide.h

Prototype

int PlmSlotGetFileInfo (
   DWORD dwUserId,
   DWORD dwSlotId,
   unsigned int iIndex,
   TCHAR *pszFileName,
   long *plFileBufSize,
   DWORD *pdwFileSize
)

パラメータ

  • → dwUserId
    • ユーザの ID。
  • → dwSlotId
    • スロットの ID。このスロットからファイルの情報を取得します。
  • → iIndex
    • 0 ベースのファイル インデックス。このインデックスはスロット インストール ディレクトリの中にあるどのファイルにアクセスするかを指定します。
  • ← pszFileName
    • 文字バッファへのポインタ。返り時には、このバッファは iIndex によって参照されるファイルのファイル名を保持します。
  • ←→ plFileBufSize
    • エントリ時には、pszFileName パラメータのサイズ (バイト数) を指定する long 値へのポインタ。返り時には、ファイル名の長さ (pszFileName パラメータによって参照されるバッファに保存された TCHAR の実際の数) です。
  • ← pdwFileSize
    • 返り時には、ファイルのサイズである DWORD へのポインタ。カードに転送されるファイルのサイズ (バイト数) は DWORD を超えないものと仮定します。

返り値

成功した場合、pszFileName バッファにコピーされた文字列のサイズを返します。

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

  • ERR_PILOT_BUFSIZE_TOO_SMALL
  • ERR_PILOT_INVALID_PATH
  • ERR_PILOT_INVALID_BUFFER

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PlmSlotGetFileInfo() を使用するには、ユーザ、スロット ID、スロット インストール ディレクトリの中にあるファイルのインデックスを指定します。PlmSlotGetFileInfo() はファイル名とファイル サイズを取得します。この関数はすべてのファイル タイプに対して機能します。

スロット ID を取得するには、ユーザ データ API の UmSlotGetInfo() 関数を使用します。

pszFileName バッファがファイル名を保持するには小さすぎる場合、この関数は ERR_PILOT_BUFSIZE_TOO_SMALL を返し、実際に必要なサイズを plFileBufSize パラメータに保存します。ユーザのスロット インストール ディレクトリのパスを取得する際に問題があった場合、ERR_PILOT_INVALID_PATH が返されます。

例

通常以下に示すように、あなたは PlmSlotGetFileCount() を呼び出して、それから各ファイルのファイル名とサイズを取得するためにループの中で PlmSlotGetFileInfo() を呼び出します。

long nFileCount;
   int retval = PlmSlotGetFileCount (dwUserId, dwSlotId,
      &nFileCount);
   TCHAR szFileName [256];
   for (int i = 0; i < nFileCount; i++)
   {
      dwFileSize = sizeof (szFileName);
      PlmSlotGetFileInfo (dwUserId, dwSlotId, i, szFileName,
         &nBufSize, &dwFileSize);
   }

互換性

  • インストール援助機能バージョン: 4.0 以降
  • Palm OS バージョン: 4.0 以降

参照

PltGetFileInfo(), UmSlotGetInfo()

PlmSlotInstallFile 関数 ^TOP^

目的

ユーザのハンドヘルドの拡張カードの中にある補助記憶装置にインストールするファイルをキューに追加します。

宣言されている場所

InstAide.h

Prototype

int PlmSlotInstallFile (
   DWORD dwUserId,
   DWORD dwSlotId,
   const TCHAR *pszFileName
)

パラメータ

  • → dwUserId
    • ユーザの ID。
  • → dwSlotId
    • ファイルをインストールするスロットの ID。
  • → pszFileName
    • インストールするファイルのフル パスとファイル名を保持している文字バッファへのポインタ。

返り値

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

成功しなかった場合、以下の負数のエラー コード値の 1 つを返します:

  • ERR_PILOT_INVALID_FILENAME
  • ERR_PILOT_INVALID_FILE_TYPE
  • ERR_PILOT_INVALID_PATH
  • ERR_PILOT_FILE_ALREADY_EXISTS
  • ERR_PILOT_INVALID_SOURCE_FILE
  • ERR_PILOT_COPY_FAILED

すべてのインストール援助機能エラー コードについての説明は、「インストール援助機能エラー コード」 を参照してください。

コメント

PlmSlotInstallFile() は pszFileName で指定されたファイルを dwUserId と dwSlotId で指定されたスロット インストール ディレクトリにコピーし、HotSync マネージャに次の HotSync の最中にファイルをインストールする必要があるということを通知するためにコンフィグレーション エントリを変更します。この関数はすべてのファイル タイプを受け付けます。

スロット ID を取得するには、ユーザ データ API の UmSlotGetInfo() を使用します。

例

int retval = PlmSlotInstallFile (dwUserId, dwSlotId,
   "C:\MyDocuments\SummitAgenda.doc");

互換性

  • インストール援助機能バージョン: 4.0 以降
  • Palm OS バージョン: 4.0 以降

PltInstallFile(), PlmSlotRemoveInstallFile(), UmSlotGetInfo()

PlmSlotMoveInstallFile 関数 ^TOP^

目的

ユーザのハンドヘルドの拡張スロットの中にある補助記憶装置にインストールするためにすでにキューに追加されているファイルのインストール先をある拡張スロットから他の拡張スロットに変更します。

宣言されている場所

InstAide.h

Prototype

int PlmSlotMoveInstallFile (
   DWORD dwUserId,
   DWORD dwSlotIdFrom,
   const TCHAR *pszFileName,
   DWORD dwSlotIdTo
)

パラメータ

  • → dwUserId
    • ユーザの ID。
  • → dwSlotIdFrom
    • ソース スロット (ここからファイルを移動させます) の ID。ファイルは現在このスロットのインストール ディレクトリの中に存在しています。
  • → pszFileName
    • 移動させるファイルのファイル名だけ (パスは含みません) を保持している文字バッファへのポインタ。
  • → dwSlotIdTo
    • 移動先スロット (ファイルをここへ移動させます) の ID。ファイルはこのスロットのインストール ディレクトリへ移動させられます。

返り値

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

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

  • ERR_PILOT_INVALID_FILENAME
  • ERR_PILOT_INVALID_PATH
  • ERR_PALM_FILE_MOVE_FAILED

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PlmSlotMoveInstallFile() はデスクトップ コンピュータ上にあるファイルをあるスロット インストール ディレクトリから他のインストール ディレクトリに移動させます。この関数は複数のスロットを持つハンドヘルドのユーザにとって有用です。この関数はすべてのファイル タイプを受け付けます。

スロット ID を取得するには、ユーザ データ API の UmSlotGetInfo() を使用します。

例

int retval = PlmSlotMoveInstallFile (dwUserId, dwSlotIdFrom,
   "SummitAgenda.doc", dwSlotIdTo);

互換性

  • インストール援助機能バージョン: 4.0 以降
  • Palm OS バージョン: 4.0 以降

参照

PlmMoveInstallFileToHandheld(), PlmMoveInstallFileToSlot(), UmSlotGetInfo()

PlmSlotRemoveInstallFile 関数 ^TOP^

目的

ユーザのハンドヘルドの拡張スロットの中にある補助記憶装置にインストールするファイルのキューからファイルを削除します。

宣言されている場所

InstAide.h

Prototype

int PlmSlotRemoveInstallFile (
   DWORD dwUserId,
   DWORD dwSlotId,
   const TCHAR *pszFileName
)

パラメータ

  • → dwUserId
    • ユーザの ID。
  • → dwSlotId
    • スロットの ID。ここからファイルを削除します。
  • → pszFileName
    • 削除するファイルのファイル名を保持している文字バッファへのポインタ; パスは必要ありません。

返り値

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

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

  • ERR_PILOT_INVALID_FILENAME
  • ERR_PILOT_INVALID_PATH
  • ERR_PALM_FILE_DELETE_FAILED

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PlmSlotRemoveInstallFile() は指定されたユーザのためのスロット インストール ディレクトリに追加されているデスクトップ コンピュータ上にあるファイルを削除します。この関数はすべてのファイル タイプを受け付けます。

スロット ID を取得するには、ユーザ データ API の UmSlotGetInfo() を使用します。

例

int retval = PlmSlotRemoveInstallFile (dwUserId, dwSlotId,
   "SummitAgenda.doc");

互換性

  • インストール援助機能バージョン: 4.0 以降
  • Palm OS バージョン: 4.0 以降

参照

PltRemoveInstallFile(), UmSlotGetInfo()

PltGetFileCount 関数 ^TOP^

目的

ユーザのハンドヘルド インストール ディレクトリの中に指定されたタイプのファイルがいくつあるかを決定します。

宣言されている場所

InstAide.h

Prototype

int PltGetFileCount (
   TCHAR *pUser,
   TCHAR *pExtension
)

パラメータ

返り値

成功した場合、ユーザのハンドヘルド インストール ディレクトリの中にある指定されたタイプのファイルの数を返します。

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PltGetFileCount() は指定された拡張子を持つファイルを扱うために登録されているインストール コンジットに関連付けされているユーザのハンドヘルド インストール ディレクトリの中に存在しているあるとくていのタイプのファイルを数を決定します。ファイル数はスロット インストール ディレクトリの中にあるファイルを含みません。スロット インストール ディレクトリの中にあるファイルをカウントするには、PlmSlotGetFileCount() 関数を呼び出します。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

PlmSlotGetFileCount()

PltGetFileInfo 関数 ^TOP^

目的

指定されたユーザの指定されたハンドヘルド インストール ディレクトリの中にあるファイルについての情報を返します。

宣言されている場所

InstAide.h

Prototype

int PltGetFileInfo (
   TCHAR *pUser,
   unsigned int iIndex,
   TCHAR *pExtension,
   TCHAR *pFileName,
   short *psFileBufSize,
   DWORD *pdwFileSize
)

パラメータ

  • → pUser
    • ユーザ名。
  • → iIndex
    • ハンドヘルド インストール ディレクトリの中にあるファイルのインデックス。これは 0 ベースのインデックスです。
  • → pExtension
  • ← pFileName
    • 返り時には、ファイルの名前。
  • ←→ psFileBufSize
    • pFileName パラメータによって参照される文字バッファのサイズ (TCHAR の数) を指定する short 値へのポインタ。返り時には、これは pFileName によって参照される実際の TCHAR の数になります。
  • ← pdwFileSize
    • 返り時には、ファイルのサイズ (バイト数)。

返り値

成功した場合、pFileName バッファにコピーされた文字列のサイズを返します。

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PltGetFileInfo() を使用するには、あなたはファイルのタイプと関連付けされているハンドヘルド インストール ディレクトリの中でのそのファイルのインデックスを指定する必要があります。PltGetFileInfo() はファイル名とファイル サイズを取得します。

あなたが提供したバッファのサイズがファイル名を保持するには小さすぎる場合、この関数は ERR_PILOT_BUFSIZE_TOO_SMALL を返して、psFileBufSize パラメータに実際に必要とされるサイズを保存します。

この関数はファイル名に加えてファイル サイズを返す点を除いて PltGetFileName() に似ています。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

PltGetFileName()

PltGetFileName 関数 ^TOP^

目的

ファイル タイプとファイルのインデックスに基づき、指定されたユーザの指定されたハンドヘルド インストール ディレクトリの中にあるファイルの名前を取得します。

宣言されている場所

InstAide.h

Prototype

int PltGetFileName (
   TCHAR *pUser,
   unsigned int iIndex,
   TCHAR *pExtension,
   TCHAR *pFileName,
   short *psFileBufSize
)

パラメータ

  • → pUser
  • → iIndex
  • → pExtension
  • ← pFileName
  • ←→ psFileBufSize

返り値

成功した場合、pFileName バッファにコピーされた文字列のサイズを返します。

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PltGetFileName() はユーザの関連付けされているハンドヘルド インストール ディレクトリの中にある指定されたタイプのファイルを反復処理します。最初のファイルの名前を取得するには 0 のインデックス値を使用し、その後に続く指定されたタイプの各ファイルに対してはインデックスを +1 します。

あなたが提供したバッファのサイズがファイル名を保持するには小さすぎる場合、この関数はエラー ERR_PILOT_BUFSIZE_TOO_SMALL を返し、実際に必要とされるサイズを psFileBufSize パラメータに保存します。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

PltGetFileInfo(), PltGetFileTypeExtension()

PltGetFileTypeExtension 関数 ^TOP^

目的

サポートされるファイル タイプ拡張子を取得します。

宣言されている場所

InstAide.h

Prototype

int PltGetFileTypeExtension (
   int iIndex,
   TCHAR *pBuffer,
   int *piBufferSize
)

パラメータ

  • → iIndex
    • ファイル名拡張子のリストでのインデックス。
  • ← pBuffer
  • ←→ piBufferSize
    • エントリ時には、pBuffer パラメータによって参照される文字バッファのサイズ (TCHAR の数) を指定する整数値へのポインタ。返り時は、pBuffer パラメータによって参照されるバッファに保存された TCHAR の実際の数。

返り値

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

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PltGetFileTypeExtension() はあなたのアプリケーションがサポートするファイル タイプを反復処理します。サポートされる最初のファイル タイプを取得するには 0 のインデックス値を使用し、それに続く各ファイル タイプに対してはインデックス値を +1 します。

拡張子文字列を取得した後、あなたはユーザの関連付けされているハンドヘルド インストール ディレクトリの中にあるそのタイプのファイルを反復処理するために PltGetFileName() や PltGetFileInfo() を使用することができます。

あなたが提供したバッファのサイズが拡張子文字列を保持するには小さすぎる場合、この関数はエラー ERR_PILOT_BUFSIZE_TOO_SMALL を返し、実際に必要とされるサイズを piBufferSize パラメータに保存します。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

PltGetFileCount(), PltGetFileName(), PltGetFileInfo()

PltGetFileTypesCount 関数 ^TOP^

目的

すべてのインストール コンジットのために HotSync マネージャに登録されているファイル タイプの数を返します。

宣言されている場所

InstAide.h

Prototype

int PltGetFileTypesCount (
   void
)

パラメータ

ありません。

返り値

成功した場合、HotSync マネージャに登録されているファイル タイプの数を返します。

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PltGetFileTypesCount() はすべてのインストール コンジットのための HotSync マネージャに登録されているファイル タイプの数を返します。あなたはそれから PltGetFileTypeExtension() を使ってそれらのタイプを反復処理することができます。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

PltGetFileTypeExtension()

PltGetInstallConduitCount 関数 ^TOP^

目的

HotSync マネージャに登録されているインストール コンジットの数を返します。

宣言されている場所

InstAide.h

Prototype

int PltGetInstallConduitCount (
   void
)

パラメータ

ありません。

返り値

成功した場合、コンフィグレーション エントリに定義することによって HotSync マネージャに登録されているインストール コンジットの数を返します。

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PltGetInstallConduitCount() は HotSync マネージャに登録されているインストール コンジットの数を決定します。あなたはそれから PltGetInstallConduitInfo() でインストール コンジットを反復処理することができます。インストール コンジットは他のコンジット (アプリケーション コンジットまたはコンポーネント コンジット) とは異なり、他のコンジットはこのカウントには含まれないということに注意してください。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

PltGetInstallConduitInfo()

PltGetInstallConduitInfo 関数 ^TOP^

目的

インデックスによって指定されたインストール コンジットについての情報を取得します。

宣言されている場所

InstAide.h

Prototype

int PltGetInstallConduitInfo (
   unsigned int iIndex,
   FileInstallType *pBuf,
   int *piBufferSize
)

パラメータ

  • → iIndex
    • コンフィグレーション エントリの中にあるインストール コンジット情報ブロックのリストでのインデックス。
  • ← pBuf
    • FileInstallType 構造体へのポインタ。返り時には、この構造体はコンフィグレーション エントリからの指定されたインストール コンジットについての情報を埋め込まれます。
  • ←→ piBufferSize
    • pBuf パラメータによって参照されるバッファのサイズ (バイト数) を指定する整数値へのポインタ。返り時には、この値は pBuf パラメータによって参照されるバッファに保存された実際のバイト数になります。

返り値

成功した場合、この関数が正しく情報をバッファに保存したことを示す定数 FILEINSTALLTYPE_SIZE を返します。

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PltGetInstallConduitInfo() は HotSync マネージャに登録されている指定されたインストール コンジットについての情報を取得します。最初のインストール コンジットについての情報を取得するには 0 のインデックス値を使用し、それに続く各コンジットに対してはインデックス値を +1 します。

あなたが提供したバッファのサイズが構造体を保持するには小さすぎる場合、この関数はエラー ERR_PILOT_BUFSIZE_TOO_SMALL を返し、実際に必要とされるサイズを piBufferSize パラメータに保存します。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

PltGetInstallConduitCount()

PltGetInstallCreatorInfo 関数 ^TOP^

目的

固有 ID によって指定されたインストール コンジットについての情報を取得します。

宣言されている場所

InstAide.h

Prototype

int PltGetInstallCreatorInfo (
   DWORD dwCreatorID,
   FileInstallType *pBuf,
   int *piBufferSize
)

パラメータ

  • → dwCreatorID
    • あなたが欲している情報を所有しているインストール コンジットの固有 ID。
  • ← pBuf
    • FileInstallType 構造体へのポインタ。返り時には、この構造体はコンフィグレーション エントリからのインストール コンジットについての情報を埋め込まれます。
  • ←→ piBufferSize
    • pBuf パラメータによって参照されるバッファのサイズ (バイト数) を指定する整数値へのポインタ。返り時には、この値は pBuf パラメータによって参照されるバッファに保存された実際のバイト数になります。

返り値

成功した場合、この関数が正しく情報をバッファに保存したことを示す定数 FILEINSTALLTYPE_SIZE を返します。

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PltGetInstallCreatorInfo() は与えられた固有 ID からインストール コンジットについての情報を取得します。

あなたが提供したバッファのサイズが構造体を保持するには小さすぎる場合、この関数はエラー ERR_PILOT_BUFSIZE_TOO_SMALL を返し、実際に必要とされるサイズを piBufferSize パラメータに保存します。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

PltGetInstallFileFilter 関数 ^TOP^

目的

デスクトップ コンピュータ上のすべてのインストール コンジットのためのすべてのファイル フィルタを取得し、フィルタ文字列を返される 1 つの文字列に連結します。

宣言されている場所

InstAide.h

Prototype

int PltGetInstallFileFilter (
   TCHAR *pFilter,
   int *piBufferSize
)

パラメータ

  • ← pFilter
    • 文字バッファへのポインタ。返り時には、このバッファはファイル フィルタ タイプ (C/C++ Sync Suite Companion の 「ファイル タイプの指定」 を参照してください) を指定する文字列を保持します。
  • ←→ piBufferSize
    • pFileter パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数値へのポインタ。返り時には、この値は pFilter パラメータによって参照されるバッファに保存された TCHAR の実際の数になります。

返り値

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

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PltGetInstallFileFilter() はファイル タイプ フィルタを保持する単一の文字列を返します。これらのファイル タイプは、現在の Windows ユーザによって作成されたすべての HotSync ユーザのために HotSync マネージャに登録されているすべてのインストール コンジットによってサポートされます。ある特定の HotSync ユーザへのスコープを制限するには、PltGetInstallFileFilterForUser() を呼び出します。

あなたが提供したバッファのサイズがフィルタ文字列を保持するには小さすぎる場合、この関数はエラー ERR_PILOT_BUFSIZE_TOO_SMALL を返し、実際に必要とされるサイズを piBufferSize パラメータに保存します。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

PltGetInstallFileFilterForUser()

PltGetInstallFileFilterForUser 関数 ^TOP^

目的

デスクトップ コンピュータ上の指定されたユーザのためのすべてのインストール コンジットのためのすべてのファイル フィルタを取得し、フィルタ文字列を返される 1 つ文字列に連結します。

宣言されている場所

InstAide.h

Prototype

int PltGetInstallFileFilterForUser (
   TCHAR *pUser,
   TCHAR *pFilter,
   int *piBufferSize
)

パラメータ

  • → pUser
    • ユーザの ID。この値が NULL である場合、この関数はすべてのユーザのためのファイル フィルタを返します。
  • ← pFilter
    • 文字バッファへのポインタ。返り時には、このバッファはファイル フィルタ タイプ (C/C++ Sync Suite Companion の 「ファイル タイプの指定」 を参照してください) を指定する文字列を保持します。
  • ←→ piBufferSize
    • pFileter パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数値へのポインタ。返り時には、この値は pFilter パラメータによって参照されるバッファに保存された TCHAR の実際の数になります。

返り値

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

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PltGetInstallFileFilterForUser() はファイル タイプ フィルタを保持する単一の文字列を返します。これらのファイル タイプは、デスクトップ コンピュータ上の指定されたユーザのために HotSync マネージャに登録されているすべてのインストール コンジットによってサポートされます。すべてのユーザに対するこの情報を取得するには、PltGetInstallFileFilter() を呼び出します。

これら 2 つの関数の間の違いは、PltGetInstallFileFilterForUser() は指定されたユーザのハンドヘルドがそのハンドヘルドのスロットの中にある拡張カードと同期をとられたかどうかを考慮します。同期をとられている場合、この関数はファイルを拡張カードにインストールするインストール コンジットによって登録されているファイル タイプも含めます。例えば、指定されたユーザのハンドヘルドがそのハンドヘルドの中にある拡張カードと同期をとられていた場合、この関数は Install to Card インストール コンジットによって登録されている "*.*" ファイル タイプ フィルタも含めます。

あなたが提供したバッファのサイズがフィルタ文字列を保持するには小さすぎる場合、この関数はエラー ERR_PILOT_BUFSIZE_TOO_SMALL を返し、実際に必要とされるサイズを piBufferSize パラメータに保存します。

互換性

  • インストール援助機能バージョン: 4.0 以降
  • Palm OS バージョン: 4.0 以降

参照

PltGetInstallFileFilter()

PltGetPath 関数 ^TOP^

目的

定義されている Palm OS Desktop パス変数の 1 つの値を取得します。

宣言されている場所

InstAide.h

Prototype

int PltGetPath (
   unsigned short sPathType,
   TCHAR *pPathBuffer,
   short *psPathBufSize
)

パラメータ

  • → sPathType
    • 取得するパス。「パス定義」 で説明されている定義されたパスの 1 つを指定します。
  • ← pPathBuffer
    • 文字バッファへのポインタ。返り時には、パス文字列を保持しています。
  • ←→ psPathBufSize
    • pPathBuffer パラメータによって査証されるバッファのサイズ (TCHAR の数) を指定する short 値へのポインタ。返り時には、この値は pPathBuffer パラメータによって参照されるバッファに保存された TCHAR の実際の数になります。

返り値

成功した場合、pPathBuffer によって参照されるバッファに実際に書き込まれた TCHAR の数を指定する整数値を返します。

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

あなたが提供したバッファのサイズがパス文字列を保持するには小さすぎる場合、この関数はエラー ERR_PILOT_BUFSIZE_TOO_SMALL を返し、実際に必要とされるサイズを psFileBufSize パラメータに保存します。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

PltSetPath()

PltGetRegistryPath 関数 ^TOP^

目的

HotSync コンフィグレーション エントリへのパスを取得します。

宣言されている場所

InstAide.h

Prototype

int PltGetRegistryPath (
   unsigned int iIndex,
   TCHAR *pBuffer,
   int *piBufferSize
)

パラメータ

  • → iIndex
    • コンフィグレーション エントリの中にあるインストールされたコンジット情報ブロックのリストでのインデックス。
  • ← pBuffer
    • 文字バッファへのポインタ。返り時には、これはパス文字列になります。
  • ←→ piBufferSize
    • pBuffer パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数値へのポインタ。返り時には、この値は pBuffer パラメータによって参照されるバッファに保存された TCHAR の実際の数になります。

返り値

成功した場合、pBuffer によって参照されるバッファに実際に書き込まれた TCHAR の数を指定する整数値を返します。

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PltGetRegistryPath() はデスクトップ コンピュータ上にある HotSync コンフィグレーション エントリのパスを取得します。

あなたが提供したバッファのサイズがパス文字列を保持するには小さすぎる場合、この関数はエラー ERR_PILOT_BUFSIZE_TOO_SMALL を返し、実際に必要とされるサイズを piBufferSize パラメータに保存します。

重要
コンフィグレーション エントリの中にある情報にアクセスするには、PltGetRegistryPath を使用しないことを PalmSource 社は推奨します。代わりに、コンジット マネージャ API、インストール コンジット マネージャ API、ユーザ データ API、それに他の インストール援助機能関数 を使用してください。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

PltGetUser 関数 ^TOP^

目的

ユーザ データ ファイルの中に保存されている i 番目のユーザの名前を取得します。

宣言されている場所

InstAide.h

Prototype

int PltGetUser (
   unsigned int iIndex,
   TCHAR *pUserBuffer,
   short *psUserBufSize
)

パラメータ

  • → iIndex
    • ユーザ データ ファイルの中のユーザのリストでのインデックス。
  • ← pUserBuffer
    • 文字バッファへのポインタ。返り時には、これはユーザ名になります。
  • ←→ psUserBufSize
    • pUserBuffer パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する short 値へのポインタ。返り時には、この値は pUserBuffer パラメータによって参照されるバッファに保存された TCHAR の実際の数になります。

返り値

成功した場合、pUserBuffer によって参照されるバッファに実際に書き込まれた TCHAR の数を指定する整数値を返します。

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PltGetUser() はデスクトップ コンピュータ上のユーザ データ ファイルの中のユーザのリストを反復処理するために使用します。

あなたが提供したバッファのサイズがパス文字列を保持するには小さすぎる場合、この関数はエラー ERR_PILOT_BUFSIZE_TOO_SMALL を返し、実際に必要とされるサイズを psUserBufSize パラメータに保存します。

NOTE
デスクトップ上のユーザについての情報にアクセスするには、インストール援助機能 API の代わりに ユーザ データ API を使用することを PalmSource 社は推奨します。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserName()

PltGetUserCount 関数 ^TOP^

目的

デスクトップ コンピュータ上のユーザ データ ファイルの中で定義されているユーザの数を返します。

宣言されている場所

InstAide.h

Prototype

int PltGetUserCount (
   void
)

パラメータ

ありません。

返り値

成功した場合、ユーザ データ ファイルの中で定義されてるユーザの数を指定する正値の整数値を返します。

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PltGerUserCount() はデスクトップ コンピュータ上のユーザ データ ファイルに登録されるユーザがどれくらいいるのかを決定します。あなたはユーザを反復処理するために PltGetUser() を使用することができます。

NOTE
デスクトップ上のユーザについての情報にアクセスするには、インストール援助機能 API の代わりに ユーザ データ API を使用することを PalmSource 社は推奨します。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

PltGetUser(), UmGetUserCount()

PltGetUserDirectory 関数 ^TOP^

目的

指定されたユーザ ディレクトリへのフル パスを取得します。

宣言されている場所

InstAide.h

Prototype

int PltGetUserDirectory (
   TCHAR *pUser,
   TCHAR *pBuffer,
   int *piBufferSize
)

パラメータ

  • → pUser
    • ユーザ名。
  • ← pBuffer
    • 文字バッファへのポインタ。返り時には、これはユーザ ディレクトリへのパスになります。
  • ←→ piBufferSize
    • pBuffer パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数値へのポインタ。返り時には、この値は pBuffer パラメータによって参照されるバッファに保存された TCHAR の実際の数になります。

返り値

成功した場合、pBuffer によって参照されるバッファに実際に書き込まれた TCHAR の数を指定する整数値を返します。

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PltGetUserDirectory() はデスクトップ コンピュータ上の指定されたユーザ ディレクトリのパスを決定します。

あなたが提供したバッファのサイズがパス文字列を保持するには小さすぎる場合、この関数はエラー ERR_PILOT_BUFSIZE_TOO_SMALL を返し、実際に必要とされるサイズを piBufferSize パラメータに保存します。

NOTE
デスクトップ上のユーザについての情報にアクセスするには、インストール援助機能 API の代わりに ユーザ データ API を使用することを PalmSource 社は推奨します。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserDirectory()

PltInstallFile 関数 ^TOP^

目的

ユーザのハンドヘルド上の主記憶装置にインストールするファイルをキューに追加します。

宣言されている場所

InstAide.h

Prototype

int PltInstallFile (
   TCHAR *pUser,
   TCHAR *pFileSpec
)

パラメータ

  • → pUser
    • ユーザ名。
  • → pFileSpec
    • インストールするファイルのパス。

返り値

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

成功しなかった場合、負数のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードについての説明は、「インストール援助機能 エラー コード」 を参照してください。

コメント

PltInstallFile() は pFileSpec で指定されたファイルをpUser で指定されたユーザ名のためのハンドヘルド インストール ディレクトリにコピーし、次の同期時に指定されたファイルをインストールするために HotSync マネージャが実行しなければならないインストール コンジットはどれなのかを指定するために "Install" コンフィグレーション エントリをセットします。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

PlmSlotInstallFile(), PltGetInstallConduitInfo()

PltIsInstallMaskSet 関数 ^TOP^

目的

指定されたインストール コンジットが指定されたユーザのために次の HotSync の最中に実行されるようセットされているかどうかを決定します。

宣言されている場所

InstAide.h

Prototype

int PltIsInstallMaskSet (
   TCHAR *pUser,
   DWORD dwMask
)

パラメータ

  • → pUser
    • ユーザ名。
  • → dwMask
    • あなたが実行状態を知りたがっているインストール コンジットに関連付けされている 1 ビット マスク。

返り値

指定されたインストール コンジットが実行されるようセットされている場合、0 より大きな値を返します。

指定されたインストール コンジットが実行されないようセットされている場合、0 の値を返します。

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

HotSync の最中に、HotSync マネージャはあなたが提供する dwMask ビット マスク値 (あなたが実行状態をチェックすることを望んだインストール コンジットに対応する) と指定されたユーザの "Install" コンフィグレーション エントリの AND をとります。この関数はあなたが指定したビット マスク値がセットされている場合 >0 の値を返します; そうでない場合、0 の値を返します。あなたが dwMask 値を知らない場合、各インストール コンジットの dwMask 値を取得するために PltGetInstallConduitInfo() を使用します。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

PltGetInstallConduitInfo()

PltIsUserProfile 関数 ^TOP^

目的

アカウントがユーザ プロファイルであるかどうかを決定します。

宣言されている場所

InstAide.h

Prototype

int PltIsUserProfile (
   TCHAR *pUser
)

パラメータ

  • → pUser
    • ユーザ名。

返り値

このアカウントがユーザ プロファイルである場合、1 を返します。

このアカウントが通常のユーザ アカウントである場合、0 を返します。

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

user profile についての更なる情報は、Introduction to Conduit Development の用語集を参照してください。

NOTE
デスクトップ上のユーザについての情報にアクセスするには、インストール援助機能 API の代わりに ユーザ データ API を使用することを PalmSource 社は推奨します。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmIsUserProfile()

PltRemoveInstallFile 関数 ^TOP^

目的

ユーザのハンドヘルドの主記憶装置にインストールするファイルのキューからファイルを削除します。

宣言されている場所

InstAide.h

Prototype

int PltRemoveInstallFile (
   TCHAR *pUser,
   TCHAR *pFileName
)

パラメータ

  • → pUser
    • ユーザの名前。
  • → pFileName
    • 削除するファイルの名前。

返り値

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

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PltRemoveInstallFile() は指定されたファイルを削除するファイル タイプに関連付けされているユーザのハンドヘルド インストール ディレクトリから削除します。

互換性

  • インストール援助機能バージョン: すべて。バージョン 4.0 で PltRemoveInstallFile() が失敗した場合、ERR_PALM_FILE_DELETE_FAILED エラー コードを返します。それより前のバージョンでは、指定されたファイルが存在しない場合にこの関数はエラー メッセージを返しません。
  • Palm OS バージョン: すべて

PltRemoveInstallRegistry 関数 ^TOP^

目的

PltSetInstallRegistry() によってセットされたイン
ストール コンジット設定を削除します。

宣言されている場所

InstAide.h

Prototype

int PltRemoveInstallRegistry ()

パラメータ

ありません。

返り値

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

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

この関数はサード パーティのインストール コンジットに影響を与えません。この関数は PltSetInstallRegistry() によってセットされた設定だけを削除します。

互換性

  • インストール援助機能バージョン: 4.1 以降
  • Palm OS バージョン: すべて

参照

PltSetInstallRegistry()

PltResetInstallMask 関数 ^TOP^

目的

指定されたインストール コンジット - 指定されたユーザのために次の HotSync の最中に実行されるよう選択されていた - の選択を解除します。

宣言されている場所

InstAide.h

Prototype

int PltResetInstallMask (
   TCHAR *pUser,
   DWORD dwMask
)

パラメータ

  • → pUser
    • ユーザ名。
  • → dwMask
    • あなたが実行させたくないインストール コンジットに関連付けされている 1 ビット マスク。

返り値

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

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

HotSync の最中に、HotSync マネージャはあなたが提供する dwMask ビット マスク値 (あなたが指定したユーザのために実行させたくないインストール コンジットに対応する) とコンフィグレーション エントリに保存されているすべてのインストール コンジットのビット マスクとの XOR をとります。結果は指定されたユーザのための "Install" コンフィグレーション エントリに保存されます。この関数の機能は "Install" エントリの中のビットをクリアし、それによって次の HotSync の最中に対応するインストール コンジットが指定されたユーザのために実行されないようにすることです。あなたが dwMask 値を知らない場合、各インストール コンジットの dwMask 値を取得するために PltGetInstallConduitInfo() を使用します。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

PltIsInstallMaskSet(), PltGetInstallConduitInfo()

PltSetInstallRegistry 関数 ^TOP^

目的

インストール コンジット情報をデフォルト値に戻します。

宣言されている場所

InstAide.h

Prototype

int PltSetInstallRegistry ()

パラメータ

ありません。

返り値

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

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PltSetInstallRegistry() は HotSync マネージャとともに出荷されるインストール コンジットのコンフィグレーション エントリをデフォルトの状態に戻します。この関数は、HotSync マネージャとともに出荷されるインストール コンジットにだけ影響を与える点を除いて、CmRestoreHotSyncSettings() に似ています。PltRemoveInstallRegistry() はこの関数がセットする設定を削除します。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

CmRestoreHotSyncSettings(), PltRemoveInstallRegistry()

PltSetPath 関数 ^TOP^

目的

Palm OS Desktop パス変数の 1 つの値をセットします。

宣言されている場所

InstAide.h

Prototype

int PltSetPath (
   unsigned short sPathType,
   TCHAR *pPathBuffer
)

パラメータ

  • → sPathType
    • セットするパス。「パス定義」 で説明されている定義されたパスの 1 つを指定します。
  • → pPathBuffer
    • コンフィグレーション エントリにセットする新しいパス値。

返り値

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

失敗した場合、負値のエラー コード値を返します。

すべてのインストール援助機能 API エラー コードの説明については、「インストール援助機能エラー コード」 を参照してください。

コメント

PltSetPath() はコンフィグレーション エントリの中のパス変数の値をセットします。

互換性

  • インストール援助機能バージョン: すべて
  • Palm OS バージョン: すべて

参照

PltGetInstallFileFilter(), PltGetPath()

インストール援助機能エラー コード ^TOP^

表 15.1 はインストール援助機能 API 関数が返す可能性のあるエラー コードの値をリスト アップしています。いくつかの関数の説明では、その関数がどのエラーを返す可能性があるのかを述べています; 他の関数の説明では、その関数が以下のエラー コードのどれでも返す可能性があるために述べていません。

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


表 15.1 インストール援助機能 API エラー コード

値 エラー コード 説明
-1 - 特定されていないエラーが起こりました。
0 - 関数は成功しました。
0xFFFFFD43 ERR_IA_INVALID_FILE_TYPE インストール援助機能はそのファイル タイプを認めません。
0xFFFFFDD4 ERR_PALM_USER_ACCESS インストール援助機能はそのユーザ データにアクセスできません。
0xFFFFFDD5 ERR_PILOT_USER_ACCESS (使用を推奨されなくなりました。代わりに ERR_PALM_USER_ACCESS をしてください。) -
0xFFFFFDD5 ERR_PALM_BAD_FILENAME 指定されたファイルは無効です。
0xFFFFFDD6 ERR_PILOT_BAD_FILENAME (使用を推奨されなくなりました。代わりに ERR_PALM_BAD_FILENAME を使用してください。) -
0xFFFFFDD6 ERR_PALM_NOT_FOUND 指定されたユーザ名をデータベースの中で見つけることができませんでした。
0xFFFFFDD7 ERR_PILOT_NOT_FOUND (使用を推奨されなくなりました。代わりに ERR_PALM_NOT_FOUND を使用してください。) -
0xFFFFFDD7 ERR_PALM_NO_USERS
0xFFFFFDD8 ERR_PALM_NO_USER_FILE,
ERR_PILOT_NO_USER_FILE (使用を推奨されなくなりました。代わりに ERR_PALM_NO_USER_FILE を使用してください。)		 ユーザ データ ファイルは見つかりませんでした。
0xFFFFFDD9 ERR_PALM_NO_DIRECTORY,
ERR_PILOT_NO_DIRECTORY (使用を推奨されなくなりました。代わりに ERR_PALM_NO_DIRECTORY を使用してください。)		 指定されたユーザのディレクトリは見つかりませんでした。
0xFFFFFDDA ERR_USER_MANAGER_BASE この値を返す関数はありません。この値はオフセットであり、いくつかのエラー コードはここをベースとします。
0xFFFFFDF4 ERR_PALM_FILE_MOVE_FAILED インストール援助機能は指定されたインストール ファイルを移動させることに失敗しました。例えば、そのファイルが存在しないためです。
0xFFFFFDF5 ERR_PALM_FILE_DELETE_FAILED インストール援助機能は指定されたインストール ファイルを削除することに失敗しました。例えば、そのファイルが存在しないためです。
0xFFFFFDF6 ERR_IA_INVALID_USER_ID PlmGetUserNameFromID() に渡されたユーザ ID は無効です。
0xFFFFFDF7 ERR_PALM_OTHER_USERSDAT_ACCESS_PROBLEM ユーザ データ ファイルにアクセスしようとしたときにその他のエラーが起こりました。
0xFFFFFDF8 ERR_PALM_SEMAPHORE_ACCESS ユーザ データ ファイルで共有に関する問題が起こりました。
0xFFFFFDF9 ERR_PALM_UNABLE_TO_CREATE_NEW_FILE 新しいユーザ データ ファイルを作成することに失敗しました。ユーザ データ ファイルは存在しませんでした; インストール援助機能は作成しようと試みましたが失敗しました。
0xFFFFFDFA ERR_PALM_NO_CORE_PATH HotSync マネージャの Core\Path コンフィグレーション エントリの値は存在しません。インストール援助機能はそれ無しにユーザ情報を取得することはできません。
0xFFFFFDFB ERR_PILOT_INVALID_CREATORID 無効な固有 ID がこの関数に渡されました。
0xFFFFFDFC ERR_PILOT_INVALID_BUFFER バッファ パラメータが NULL です。
0xFFFFFDFD ERR_PILOT_INVALID_FILE_TYPE ファイル パラメータはこの関数に対して使用するには有効なファイル タイプではありません。
0xFFFFFDFE ERR_PILOT_INVALID_INDEX インデックス パラメータがそのインデックスに対して許される最大値を超えています。
0xFFFFFDFF ERR_PILOT_INVALID_SOURCE_FILE インストール関数に渡されたファイルは有効でないか、見つかりませんでした。
0xFFFFFE00 ERR_PILOT_FILE_ALREADY_EXISTS デスクトップ上にあるユーザのインストール ディレクトリにすでに追加されているファイルをインストールしようとしました。
0xFFFFFE01 ERR_PILOT_INVALID_PATH PltSetPath() 関数に渡されたパス パラメータが NULL です。
0xFFFFFE02 ERR_PILOT_INVALID_REGISTRY リクエストされたパス情報はコンフィグレーション エントリに保存されていません。Palm OS Desktop インストール プログラムを実行させるとしばしばこの問題は修正されます。
0xFFFFFE03 ERR_PILOT_INVALID_PATH_TYPE パス タイプ パラメータの値は有効なパス タイプの値ではありません。パス タイプ定数についての情報は、「パス定義」 を参照してください。
0xFFFFFE04 ERR_PILOT_USERSDAT_ALREADY_EXISTS このエラー コードを返す関数はありません。
0xFFFFFE05 ERR_PILOT_INVALID_FILE_INDEX 渡されたファイル インデックス パラメータの値がファイルの数より大きいです。
0xFFFFFE06 ERR_PILOT_INVALID_FILENAME インストール関数の呼び出しの中のファイル名パラメータが NULL です。
0xFFFFFE07 ERR_IA_INVALID_USER ユーザ名パラメータが NULL であるか、あるいは有効なユーザ名ではありません。
0xFFFFFE08 ERR_PILOT_COPY_FAILED インストール援助機能はそのファイルをコピーすることができませんでした。
0xFFFFFE09 ERR_PILOT_NO_USERSDAT_FILE ユーザ データ ファイルがありません。
0xFFFFFE0A ERR_PILOT_BUFSIZE_TOO_SMALL 関数にパラメータとして提供されたバッファはその関数が保存しようとした情報を保持するには小さすぎるか、あるいは無効です。
0xFFFFFE0B ERR_PILOT_INVALID_USER_INDEX インデックス パラメータの値はユーザの数よりも大きいです。
0xFFFFFE0C ERR_PILOT_NO_USERS そのユーザ データ ファイルはユーザ情報を保持していません。

←　14 章に戻る　↑トップへ　16 章に進む　→

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

Index


メニュー

各種掲示板

検索

キーワード

Wiki

最新

2023/12/1

2021/4/5

2020/7/7

2020/5/15

2020/1/13

2019/4/1

2018/4/18

2018/4/17

Visitor:
[Today:]
[Yesterday:]