Palm Programmer's Laboratory

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

C/C++ Sync Suite Reference601/16

←　15 章に戻る　↑トップへ　17 章に進む　→

16 ユーザ データ API

ユーザ データ API はデスクトップ コンピュータ上の ユーザ データ保存場所 にアクセスします。ユーザ データ保存場所はカレント Windows ユーザによって作成されたすべてほ HotSync ユーザの名前、同期設定、ディレクトリ、パスワード情報を保持します。

ユーザ データ関数は UserData.dll の中で利用可能であり、UserData.h の中で宣言されています。

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

更なる情報は、C/C++ Sync Suite Companion の 「ユーザ データ API の使用」 を参照してください。

ユーザ データ API バージョン ^TOP^

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

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

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

例えば、あなたのアプリケーションがユーザ データ API のバージョン 4.0 で追加された関数に依存する場合、あなたは UmGetLibVersion() を呼び出し、それからメジャ バージョン番号が 4 以上でありマイナ バージョン番号が 0 以上であることを確認する必要があります。

ユーザ データ API の新しい Feature とその他の変更点についての要約は、付録 A 「改訂履歴」 を参照してください。

ユーザ データ API 定数 ^TOP^

この節では、あなたがユーザ データ API で使用する以下の列挙定数とプロセッサ定数のグループについて説明します。

定数 説明
UmUserSyncAction ある特定のコンジットで実行される同期のタイプを決定するユーザ設定を定義します。
Palm OS バージョンのセクションとキー名 ユーザ データ保存場所の中にあるセクションとキー名を定義します。これらはハンドヘルドの Palm OS バージョン番号が保存されている場所を指定します。
ユーザ データ API のバージョン UmGetLibVersion() が返すユーザ データ API のバージョンを定義します。

UmUserSyncAction 列挙体 ^TOP^

目的

ある特定のコンジットで実行される同期のタイプを決定するユーザ設定を定義します。

宣言されている場所

UserData.h

定数

  • Synchronize = 0
    • デスクトップ コンピュータとハンドヘルド間でミラー イメージ同期を実行します。
  • PCToHH
    • デスクトップ コンピュータからのリストアを実行します: ハンドヘルド上のデータベースをデスクトップ コンピュータ上のデータベースで上書きします。
  • HHToPC
    • ハンドヘルドからのリストアを実行します: デスクトップ コンピュータ上のデータベースをハンドヘルド上のデータベースで上書きします。
  • DoNothing
    • ハンドヘルドとデスクトップ コンピュータ間でデータの交換を行いません。しかしながら、HotSync マネージャはコンジットをロードします。ロードされたコンジットはフラグ、ログ メッセージをセットしたり、必要に応じてその他のハウスキーピング (訳者: 本来は家事のこと。データの整理をすることなどを意味するらしい。) を行うことができます。
  • Custom
    • コンジットに実装されているカスタム アクションを実行します。HotSync マネージャはこのフラグをコンジットに渡すだけであり、コンジットが実行するアクションを決定しなければなりません。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserPermSyncPreferences(), UmGetUserTempSyncPreferences(), UmSetUserPermSyncPreferences(), UmSetUserTempSyncPreferences()

Palm OS バージョンのセクションとキー名 ^TOP^

目的

ユーザ データ保存場所の中にあるセクションとキー名を定義します。これらはハンドヘルドの Palm OS バージョン番号が保存されている場所を指定します。

宣言されている場所

UserData.h

定数

  • #define DEVICE_INFO_SECTION_NAME "Device Information"
    • ユーザのハンドヘルドについての情報を保持しているユーザ データ保存場所のセクションを指定します。
  • #define DEVICE_ROM_VERSION "RomVersion"
    • DEVICE_INFO_SECTION_NAME セクションの中のキーを指定します。この値はユーザのハンドヘルド上の Palm OS のバージョンを定義します。

コメント

HotSync マネージャ バージョン 6.0 以降はユーザのハンドヘルドとユーザ データ保存場所から Palm OS のバージョンを取得します。そのため、あなたは HotSync を実施していないときにも Palm OS のバージョンを取得することができます。この値を取得するには、UmGetInteger() を呼び出し、上記のセクションとキー名を指定します。それから SYNCROMVMAJOR() マクロと SYNCROMVMINOR() マクロを使ってバージョン番号をデコードします。

互換性

  • ユーザ データ API バージョン: バージョン 4.2 よりも後
  • Palm OS バージョン:すべて

参照

UmGetString(), UmSetString()

ユーザ データ API のバージョン ^TOP^

目的

UmGetLibVersion() が返すユーザ データ API のバージョンを定義します。

宣言されている場所

UserData.h

定数

  • #define UM_LIB_VER_MAJOR 4
    • メジャ バージョン番号を意味します。
  • #define UM_LIB_VER_MINOR 2
    • マイナ バージョン番号を意味します。

コメント

ユーザ データ API のバージョン 4.1 以降はこれらの値を定義します。これらの値は UmGetLibVersion() が返します。バージョン 4.0 では、これらの値は定義されていません。しかしながら、UmGetLibVersion() はメジャ バージョン番号として 4 を、マイナ バージョン番号として 0 を返すため、最初のバージョン番号 (訳者: メジャ バージョン番号) は利用可能です。

互換性

  • ユーザ データ API バージョン: 4.1 以降
  • Palm OS バージョン: すべて

参照

UmGetLibVersion()

ユーザ データ API 関数 ^TOP^

この節では、アプリケーションとコンジットがユーザ データ保存場所にアクセスするために使用することができある以下の関数について説明します。

関数 説明
UmAddUser() ユーザをユーザ データ保存場所に追加します。
UmClearInstallMask() 次の HotSync の最中に指定されたユーザのために実行することになっている指定されたインストール コンジットの選択を解除します。
UmDeleteKey() ユーザ データ保存場所の指定されたユーザのエリアからキーまたはセクション全体を削除します。
UmDeleteUser() ユーザ データ保存場所からユーザを削除します。
UmDeleteUserPermSyncPreferences() 指定されたユーザのすべてのコンジットの永久同期設定を削除します。
UmDeleteUserTempSyncPreferences() 指定されたユーザのすべてのコンジットの一時同期設定を削除します。
UmGetIDFromName() 与えられたユーザの名前からユーザ ID を取得します。
UmGetIDFromPath() 与えられたユーザ ディレクトリからユーザ ID を取得します。
UmGetInteger() ユーザ データ保存場所の指定されたユーザのエリアの中にあるキーから整数値を取得します。
UmGetLibVersion() ユーザ データ API のバージョンを取得します。
UmGetRootDirectory() デスクトップ コンピュータ上のすべてのユーザ ディレクトリのパス (Core\Path コンフィグレーション エントリに保存されている) を取得します。
UmGetString() ユーザ データ保存場所の指定されたユーザのエリアの中にあるキーから文字列値を取得します。
UmGetUserCount() ユーザ データ保存場所の中に存在するユーザの数を返します。
UmGetUserDirectory() 指定されたユーザ ID のユーザ ディレクトリの名前を取得します。
UmGetUserID() インデックスによってユーザ データ保存場所からユーザ ID を返します。
UmGetUserName() 与えられたユーザ ID からユーザ データ保存場所の中に存在するユーザ名を取得します。
UmGetUserPassword() 指定されたユーザ ID から暗号化されたユーザ パスワードを取得します。
UmGetUserPermSyncPreferences() 指定されたユーザ ID からコンジットの永久同期設定を取得します。
UmGetUserTempSyncPreferences() 指定されたユーザ ID からコンジットの一時同期設定を取得します。
UmIsInstallMaskSet() 指定されたインストール コンジットが次の HotSync の最中に指定されたユーザのために実行されるようにセットされているかどうかを決定します。
UmIsUserInstalled() 指定されたユーザが「インストールされている」かどうかを決定します。
UmIsUserNameValid() 提供された文字列が有効な HotSync ユーザ名であるかどうかを決定します。
UmIsUserProfile() アカウントがユーザ プロファイルであるかどうかを決定します。
UmRemoveUserTempSyncPreferences() 指定されたユーザ ID の指定されたコンジットの一時同期設定を削除します。
UmSetInstallMask() 指定されたインストール コンジットを次の HotSync の最中に指定されたユーザのために実行するよう選択します。
UmSetInteger() ユーザ データ保存場所の指定されたユーザのエリアの中にあるキーに整数値をセットします。
UmSetString() ユーザ データ保存場所の指定されたユーザのエリアの中にあるキーに文字列値をセットします。
UmSetUserDirectory() 指定されたユーザ ID のディレクトリ名をセットします。
UmSetUserInstall() 指定されたユーザ ID の "installed" (「インストールされた」) フラグをセットまたはクリアします。
UmSetUserName() 指定されたユーザ ID のユーザ名をセットします。
UmSetUserPermSyncPreferences() 指定されたユーザ ID のコンジットの永久同期設定をセットします。
UmSetUserTempSyncPreferences() 指定されたユーザ ID のコンジットの一時同期設定をセットします。
UmSlotGetDisplayName() 指定されたユーザのハンドヘルド上にある指定されたスロットの表示名を取得します。
UmSlotGetExpMgrVersion() 指定されたユーザのハンドヘルドの拡張マネージャのバージョンを取得します。
UmSlotGetInfo() 指定されたユーザのハンドヘルド上に存在する各拡張スロットのスロット ID を取得します。
UmSlotGetInstallDirectory() 指定されたユーザとハンドヘルド スロットからスロット インストール ディレクトリ名 (フル パスではありません) を取得します。
UmSlotGetMediaType() 指定されたユーザのハンドヘルドの指定されたスロットのメディア タイプを取得します。
UmSlotGetSlotCount() 指定されたユーザのハンドヘルド上にある拡張スロットの数を取得します。

UmAddUser 関数 ^TOP^

目的

ユーザをユーザ データ保存場所に追加します。

宣言されている場所

UserData.h

Prototype

long UmAddUser (
   const char *pUser,
   BOOL bProfileUser
)

パラメータ

  • → pUser
    • 追加するユーザの名前を指定する文字バッファへのポインタ。
  • → bProfileUser
    • これが true である場合、この関数は pUser で指定された名前を持つ新しい ユーザ プロファイル を作成します。false である場合、通常のユーザ アカウントを作成します。

返り値

成功した場合、0 を返します。ユーザ データ保存場所が存在しない場合、この関数は保存場所を作成し、ユーザを追加し、それらが成功した場合に 0 を返します。

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

  • ERR_UM_BAD_FILENAME
  • ERR_UM_INVALID_USER_NAME
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SAVE_ERR
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS
  • ERR_UM_USER_ALREADY_EXISTS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

ユーザ名をこの関数に渡す前に、UmIsUserNameValid() を呼び出してユーザ名が有効であるかどうか検証してください。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmIsUserNameValid(), UmIsUserProfile(), UmDeleteUser()

UmClearInstallMask 関数 ^TOP^

目的

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

宣言されている場所

UserData.h

Prototype

long UmClearInstallMask (
   DWORD dwUserID,
   DWORD dwMask
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • → dwMask
    • あなたが実行されないようにしようとしているインストール コンジットに関連付けされている 1 ビット マスク。

返り値

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

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

  • ERR_UM_BAD_FILENAME
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

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

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmSetInstallMask(), UmIsInstallMaskSet()

UmDeleteKey 関数 ^TOP^

目的

ユーザ データ保存場所の指定されたユーザのエリアからキーまたはセクション全体を削除します。

宣言されている場所

UserData.h

Prototype

long UmDeleteKey (
   DWORD dwUserID,
   const TCHAR *pszSection,
   const TCHAR *pszKey
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • → pszSection
    • ユーザ データ保存場所の指定されたエリアの中にあるセクション名。
  • → pszKey
    • 削除するキー。これが NULL である場合、セクション全体が削除されます。

返り値

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

失敗した場合、以下のエラー コード値の 1 つを返します。特に、この関数がキーまたはセクションを削除できない場合、ERR_UM_CANNOT_WRITE_TO_STORE を返します。

  • ERR_UM_BAD_FILENAME
  • ERR_UM_BUFSIZE_TOO_SMALL
  • ERR_UM_CANNOT_WRITE_TO_STORE
  • ERR_UM_INVALID_POINTER
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID()

UmDeleteUser 関数 ^TOP^

目的

ユーザ データ保存場所からユーザを削除します。

宣言されている場所

UserData.h

Prototype

long UmDeleteUser (
   DWORD dwUserID
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。

返り値

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

  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_USERS
  • ERR_UM_SAVE_ERR
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_INVALID_POINTER
  • ERR_UM_USER_ALREADY_EXISTS
  • ERR_UM_USER_DIR_ALREADY_IN_USE
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmAddUser()

UmDeleteUserPermSyncPreferences 関数 ^TOP^

目的

指定されたユーザのすべてのコンジットの永久同期設定を削除します。

宣言されている場所

UserData.h

Prototype

long UmDeleteUserPermSyncPreferences (
   DWORD dwUserID,
   DWORD dwCreatorID
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • → dwCreatorID
    • この値は無視されます。

返り値

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

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

  • ERR_UM_BAD_FILENAME
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SAVE_ERR
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

UmDeleteUserPermSyncPreferences() はすべてのコンジットの永久同期設定をクリアします。結果はユーザが HotSync マネージャの Custom > Change オプションをクリックして永久同期設定を変更していない場合と同じになります。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmSetUserPermSyncPreferences(), UmGetUserPermSyncPreferences()

UmDeleteUserTempSyncPreferences 関数 ^TOP^

目的

指定されたユーザのすべてのコンジットの一時同期設定を削除します。

宣言されている場所

UserData.h

Prototype

long UmDeleteUserTempSyncPreferences (
   DWORD dwUserID,
   DWORD dwCreatorID
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • → dwCreatorID
    • この値は無視されます。

返り値

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

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

  • ERR_UM_BAD_FILENAME
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SAVE_ERR
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

UmDeleteUserTempSyncPreferences() はすべてのコンジットの一時同期設定をクリアし、それにより次の HotSync ではコンジットの永久同期設定にセットされているアクション セットが実行されます。結果はユーザが HotSync マネージャの Custom > Change オプションをクリックして一時同期設定を変更していない場合と同じになります。

NOTE
この関数はすべてのコンジットの一時同期設定をクリアします。これとは対照的に UmRemoveUserTempSyncPreferences() は 1 つだけのコンジットの一時同期設定をクリアします。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmSetUserTempSyncPreferences(), UmGetUserTempSyncPreferences(), UmRemoveUserTempSyncPreferences()

UmGetIDFromName 関数 ^TOP^

目的

与えられたユーザの名前からユーザ ID を取得します。

宣言されている場所

UserData.h

Prototype

long UmGetIDFromName (
   const TCHAR *pszName,
   DWORD *pdwUserID
)

パラメータ

  • → pszName
    • ユーザ名を保持している文字バッファへのポインタ。
  • ← pdwUserID
    • ユーザ ID を受け取るバッファ。

返り値

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

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

  • EE_UM_BAD_FILENAME
  • EE_UM_BUFSIZE_TOO_SMALL
  • EE_UM_INVALID_POINTER
  • EE_UM_NO_CORE_PATH
  • EE_UM_NO_DIRECTORY
  • EE_UM_NO_USER_FOUND
  • EE_UM_NO_USERS
  • EE_UM_NO_USERSDAT_FILE
  • EE_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • EE_UM_SEMAPHORE_ACCESS
  • EE_UM_UNABLE_TO_CREATE_NEW_FILE
  • EE_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

ユーザ データ保存場所は同じ名前を保持している可能性があります。ユーザ データ API が固有であると保証するのはユーザ ID だけであるので、同じ名前を持つ各インスタンスは異なるユーザ ID を持ちます。それゆえ、同じ名前を持つインスタンスがある場合、あなたはユーザ名が固有であるかどうか決定するために追加のチェックを行わなければなりません。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID()

UmGetIDFromPath 関数 ^TOP^

目的

与えられたユーザ ディレクトリからユーザ ID を取得します。

宣言されている場所

UserData.h

Prototype

long UmGetIDFromPath (
   const TCHAR *pszPath,
   DWORD *pdwUserID
)

パラメータ

  • → pszPath
    • ユーザ ディレクトリへのパスを保持している文字バッファへのポインタ。
  • ← pdwUserID
    • ユーザ ID を受け取るバッファ。

返り値

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

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

  • EE_UM_BAD_FILENAME
  • EE_UM_BUFSIZE_TOO_SMALL
  • EE_UM_INVALID_POINTER
  • EE_UM_INVALID_USER
  • EE_UM_INVALID_USER_DIR
  • EE_UM_NO_CORE_PATH
  • EE_UM_NO_DIRECTORY
  • EE_UM_NO_USER_FOUND
  • EE_UM_NO_USERS
  • EE_UM_NO_USERSDAT_FILE
  • EE_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • EE_UM_SEMAPHORE_ACCESS
  • EE_UM_UNABLE_TO_CREATE_NEW_FILE
  • EE_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID()

UmGetInteger 関数 ^TOP^

目的

ユーザ データ保存場所の指定されたユーザのエリアの中にあるキーから整数値を取得します。

宣言されている場所

UserData.h

Prototype

long UmGetInteger (
   DWORD dwUserID,
   const TCHAR *pszSection,
   const TCHAR *pszKey,
   long *pBuf,
   long lDefault
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • → pszSection
    • ユーザ データ保存場所の指定されたユーザのエリアの中にあるセクション名。
  • → pszKey
    • 受け取る整数のキー。
  • ← pBuf
    • 整数を受け取るバッファ。
  • → lDefault
    • 指定されたキーに対して何の整数も受け取れなかった場合に返されるデフォルトの整数値。

返り値

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

失敗した場合、以下のエラー コード値の 1 つを返し、pBuf に lDefault で指定された値をセットします。

  • EE_UM_BAD_FILENAME
  • EE_UM_BUFSIZE_TOO_SMALL
  • EE_UM_INVALID_POINTER
  • EE_UM_INVALID_USER
  • EE_UM_NO_CORE_PATH
  • EE_UM_NO_DIRECTORY
  • EE_UM_NO_USER_FOUND
  • EE_UM_NO_USERS
  • EE_UM_NO_USERSDAT_FILE
  • EE_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • EE_UM_SEMAPHORE_ACCESS
  • EE_UM_UNABLE_TO_CREATE_NEW_FILE
  • EE_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

与えられたセクションの名前とキーによってユーザ データ保存場所の中にある整数キーの値を読み込むためにこの関数を使用します。あなたはこの関数を使ってあなたが作成したキーを読み込むことができます。しかしながら、値を読み込むためのユーザ データ API 関数が存在している場合、この汎用関数ではなく、その専用関数を使用してください。
HotSync マネージャ バージョン 6.0 以降はユーザのハンドヘルドから Palm OS のバージョンを取得し、それをユーザ データ保存場所に保存します。ユーザ データ API はその Palm OS バージョン番号を読み込むための専用関数を提供していないため、バージョン番号を読み込むにはこの関数を使用して 「Palm OS バージョンのセクションとキー名」 で説明されているセクションとキー名を渡す必要があります。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmSetInteger()

UmGetLibVersion 関数 ^TOP^

目的

ユーザ データ API のバージョンを取得します。

宣言されている場所

UserData.h

Prototype

long UmGetLibVersion (
   DWORD *pdwMajor,
   DWORD *pdwMinor
)

パラメータ

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

返り値

常に 0 を返します。

コメント

ユーザ データ API 関数を呼び出す前にあなたが使用しているユーザ データ API のバージョンを決定するために UmGetLibVersion() を呼び出します。更なる情報は、「ユーザ データ API バージョン」 を参照してください。バージョン間で行われた変更についての詳細は、付録 A 「改訂履歴」 を参照してください。

この関数が返すバージョン番号定数は 「ユーザ データ API のバージョン」 で定義されています。

互換性

  • ユーザ データ API バージョン: 4.0 以降
  • Palm OS バージョン: すべて

UmGetRootDirectory 関数 ^TOP^

目的

デスクトップ コンピュータ上のすべてのユーザ ディレクトリのパス (Core\Path コンフィグレーション エントリに保存されている) を取得します。

宣言されている場所

UserData.h

Prototype

long UmGetRootDirectory (
   TCHAR *pRootDirBuffer,
   short *psRootDirBufSize
)

パラメータ

  • ← pRootDirBuffer
    • パスが返される文字バッファへのポインタ。
  • ← psRootDirBufSize
    • パスのサイズが返される short へのポインタ。

返り値

成功した場合、ルート パスの長さである 0 よりも大きな値を返します。さらに、同じ長さの値が psRootDirBuffer に保存されます。
ルート パスが見つからなかった場合、0 を返します。

失敗した場合、以下のエラー コード値の 1 つを返します。バッファがルート パスを保持するのに十分な大きさがない場合、この関数は psRootDirBufSize に必要とされるサイズをセットし、エラー ERR_UM_BUFSIZE_TOO_SMALL を返します。

  • EE_UM_BUFSIZE_TOO_SMALL
  • EE_UM_INVALID_POINTER
  • EE_UM_NO_CORE_PATH
  • EE_UM_NO_USERS
  • EE_UM_NO_USERSDAT_FILE
  • EE_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • EE_UM_SEMAPHORE_ACCESS
  • EE_UM_UNABLE_TO_CREATE_NEW_FILE

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

UmGetRootDirectory() は Core\Path コンフィグレーション エントリの中に保存されている値を取得します。HotSync マネージャ バージョン 6.0 以降は複数の Windows ユーザを認識するため、各 Windows ユーザは別個の Core\Path 値を持たなければなりません。Windows の標準のユーザ データの置き場所に合わせると、通常は C:\Documents and Settings\<WinUsername>\My Documents\Palm OS Desktop になります。あなたが HotSync ユーザのディレクトリのフル パスを必要とする場合、UmGetUserDirectory() を呼び出し、それによって得られたパスを Core\Path 値に付加します。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserDirectory(), UmSetUserDirectory()

UmGetString 関数 ^TOP^

目的

ユーザ データ保存場所の指定されたユーザのエリアの中にあるキーから文字列値を取得します。

宣言されている場所

UserData.h

Prototype

long UmGetString (
   DWORD dwUserID,
   const TCHAR *pszSection,
   const TCHAR *pszKey,
   TCHAR *pBuf,
   long *lSize,
   const TCHAR *pszDefault
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • → pszSection
    • ユーザ データ保存場所の指定されたユーザのエリアの中にあるセクション名。
  • → pszKey
    • 取得する文字列のキー。
  • ← pBuf
    • 文字列を受け取るためのバッファ。
  • ←→ lSize
    • pBuf によって参照されるバッファのサイズ (バイト数) を指定する long 値へのポインタ。返り時には、この値は pBuf の実際のサイズになります。バッファが小さすぎたためにこの関数が失敗した場合、返り時の lpSize の値は文字列を保持するのに必要とされるサイズになります。
  • → pszDefault
    • 指定されたキーに対して文字列を取得することができなかった場合に返されるデフォルトの文字列。

返り値

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

失敗した場合、以下のエラー コード値の 1 つを返します。バッファが文字列を保持するのに十分な大きさを持っていない場合、この関数は lpSize を必要とされるサイズにセットし、エラー コード ERR_UM_BUFSIZE_TOO_SMALL を返します。文字列を取得することができなかった場合、pszDefault が pBuf に返されます。

  • EE_UM_BAD_FILENAME
  • EE_UM_BUFSIZE_TOO_SMALL
  • EE_UM_INVALID_POINTER
  • EE_UM_INVALID_USER
  • EE_UM_NO_CORE_PATH
  • EE_UM_NO_DIRECTORY
  • EE_UM_NO_USER_FOUND
  • EE_UM_NO_USERS
  • EE_UM_NO_USERSDAT_FILE
  • EE_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • EE_UM_SEMAPHORE_ACCESS
  • EE_UM_STRING_TOO_BIG
  • EE_UM_UNABLE_TO_CREATE_NEW_FILE
  • EE_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

与えられたセクション名とキーによってユーザ データ保存場所の中にある文字列キーの値を読み込むためにこの関数を使用します。あなたはこの関数を使用してあなたが作成したキーを読み込むことができます。しかしながら、値を読み込むためのユーザ データ API 関数が存在する場合、この汎用関数ではなくその専用関数を使用してください。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmSetString()

UmGetUserCount 関数 ^TOP^

目的

ユーザ データ保存場所の中に存在するユーザの数を返します。

宣言されている場所

UserData.h

Prototype

short UmGetUserCount (
   void
)

パラメータ

ありません。

返り値

成功した場合、ユーザ データ保存場所の中に存在するユーザの数である 0 以上の値を返します。

失敗した場合、以下のエラー コード値の 1 つである 0 より小さな値を返します:

  • EE_UM_NO_CORE_PATH
  • EE_UM_NO_USERS
  • EE_UM_NO_USERSDAT_FILE
  • EE_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • EE_UM_SEMAPHORE_ACCESS
  • EE_UM_UNABLE_TO_CREATE_NEW_FILE

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

UmGetUserDirectory 関数 ^TOP^

目的

指定されたユーザ ID のユーザ ディレクトリの名前を取得します。

宣言されている場所

UserData.h

Prototype

long UmGetUserDirectory (
   DWORD dwUserID,
   TCHAR *pUserDirBuffer,
   short *psUserDirBufSize
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • ← pUserDirBuffer
    • TCHAR バッファへのポインタ。返り時に、このバッファは指定されたユーザのディレクトリ名を保持しています。
  • ←→ psUserDirBufSize
    • pUserDirBuffer によって参照されているバッファのサイズ (TCHAR の数) を指定する short 値へのポインタ。返り時に、この値は pUserDirBuffer の実際のサイズになります。バッファが小さすぎたためにこの関数が失敗した場合、返り時の psUserDirBufSize の値は必要とされるバッファ サイズになっています。

返り値

成功した場合、値 >= 0 を返します。この値は pUserDirBuffer に保存されたユーザ ディレクトリ名の長さです。

成功しなかった場合、以下のエラー コードの 1 つを返します。バッファがディレクトリ名を保持するために十分な大きさがなかった場合、この関数は psUserDirBufSize に必要とされるサイズをセットし、エラー ERR_UM_BUFSIZE_TOO_SMALL を返します。

  • ERR_UM_BAD_FILENAME
  • ERR_UM_BUFSIZE_TOO_SMALL
  • ERR_UM_INVALID_POINTER
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

完全なパスを取得するには、UmGetRootDirectory() と UmGetUserDirectory() の結果 - 例えば、root_directory = "C:\Documents and Settings\<WinUsername>\My Documents\Palm OS Desktop" と user_directory = "NUser" - を連結します。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmSetUserDirectory()

UmGetUserID 関数 ^TOP^

目的

インデックスによってユーザ データ保存場所からユーザ ID を返します。

宣言されている場所

UserData.h

Prototype

long UmGetUserID (
   short sIndex,
   DWORD *pdwUserID
)

パラメータ

  • → sIndex
    • ユーザ データ保存場所の中に存在するユーザを指定する 0 ベースのインデックス。
  • ← pdwUserID
    • ユーザ ID を受け取るための DWORD へのポインタ。

返り値

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

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

  • EE_UM_INVALID_POINTER
  • EE_UM_INVALID_USER_INDEX
  • EE_UM_NO_CORE_PATH
  • EE_UM_NO_USERS
  • EE_UM_NO_USERSDAT_FILE
  • EE_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • EE_UM_SEMAPHORE_ACCESS
  • EE_UM_UNABLE_TO_CREATE_NEW_FILE

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

互換性

  • ユーザ データ API バージョン: すべて。4.0 よりも前のバージョンは、成功した場合はユーザ ID を返し、ユーザ ID が見つからなかった場合は 0 を返し、エラーが発生した場合は負値を返しました。キャストされる前のユーザ ID の値は負になる可能性があったため、成功したばあの返り値も負値になる可能性がありました。ユーザ データ API のバージョン 4.0 では上記の「返り値」のようにこの問題が修正されました。
  • Palm OS バージョン: すべて

参照

UmGetIDFromPath(), UmGetIDFromName()

UmGetUserName 関数 ^TOP^

目的

与えられたユーザ ID からユーザ データ保存場所の中に存在するユーザ名を取得します。

宣言されている場所

UserData.h

Prototype

long UmGetUserName (
   DWORD dwUserID,
   char *pUserNameBuffer,
   short *psUserNameBufSize
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • ← pUserNameBuffer
    • 文字バッファへのポインタ。返り時には、このバッファは指定されたユーザの名前を保持します。
  • ←→ psUserNameBufSize
    • pUserNameBuffer によって参照されるバッファのサイズ (バイト数) を指定する short 値へのポインタ。返り時には、この値は pUserNameBuffer の実際のサイズになります。バッファが小さすぎたためにこの関数が失敗した場合、返り時の psUserNameBufSize の値はバッファに必要とされるサイズになります。

返り値

成功した場合、ユーザ名の長さである 0 より大きな値を返します。さらに、同じ長さの値が pUserNameBuffer に保存されます。

失敗した場合、以下のエラー コード値の 1 つを返します。バッファがユーザ名を保持するのに十分な大きさを持っていない場合、この関数は psUserNameBufSize に必要とされるサイズをセットし、エラー ERR_UM_BUFSIZE_TOO_SMALL を返します。

  • ERR_UM_BAD_FILENAME
  • ERR_UM_BUFSIZE_TOO_SMALL
  • ERR_UM_INVALID_POINTER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmSetUserName()

UmGetUserPassword 関数 ^TOP^

目的

指定されたユーザ ID から暗号化されたユーザ パスワードを取得します。

宣言されている場所

UserData.h

Prototype

long UmGetUserPassword (
   DWORD dwUserID,
   TCHAR *pUserPasswordBuffer,
   short *psUserPasswordBufSize
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • ← pUserPasswordBuffer
    • 文字バッファへのポインタ。返り時には、このバッファは指定されたユーザの暗号化されたパスワードを保持します。
  • ←→ psUserPasswordBufSize
    • pUserPasswordBuffer によって参照されるバッファのサイズ (TCHAR の数) を指定する short 値へのポインタ。返り時には、この値は pUserPasswordBuffer の実際のサイズになります。バッファが小さすぎたためにこの関数が失敗した場合、返り時の psUserPasswordBufSize の値はバッファに必要とされるサイズになります。

返り値

成功した場合、パスワードの長さである 0 以上の値を返します。さらに、同じ長さの値が pUserPasswordBuffer に保存されます。

失敗した場合、以下の非 0 のエラー コード値の 1 つである 0 より小さな値を返します。バッファがパスワードを保持するのに十分な大きさを持っていない場合、この関数は psUserPasswordBufSize に必要とされるサイズをセットし、エラー ERR_UM_BUFSIZE_TOO_SMALL を返します。

  • ERR_UM_BAD_FILENAME
  • ERR_UM_BUFSIZE_TOO_SMALL
  • ERR_UM_INVALID_POINTER
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

互換性

参照

UmGetUserID()

UmGetUserPermSyncPreferences 関数 ^TOP^

目的

指定されたユーザ ID からコンジットの永久同期設定を取得します。

宣言されている場所

UserData.h

Prototype

long UmGetUserPermSyncPreferences (
   DWORD dwUserID,
   DWORD dwCreatorID,
   long *pUsaAction
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • → dwCreatorID
    • アクセスするコンジットのクリエイタ ID。
  • ← pUsaAction
    • UmSetSyncAction によって定義された同期設定を受け取るための long へのポインタ。

返り値

成功した場合、UmUserSyncAction の 1 つを返します。さらにこれは pUsaAction にも返されます。

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

  • -1
    • 特定されていないエラーが起こったか、指定されたクリエイタ ID に対してセットされた永久設定は存在しません。
  • ERR_UM_BAD_FILENAME
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SAVE_ERR
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmSetUserPermSyncPreferences(), UmDeleteUserPermSyncPreferences()

UmGetUserTempSyncPreferences 関数 ^TOP^

目的

指定されたユーザ ID からコンジットの一時同期設定を取得します。

宣言されている場所

UserData.h

Prototype

long UmGetUserTempSyncPreferences (
   DWORD dwUserID,
   DWORD dwCreatorID,
   long *pUsaAction
)
  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • → dwCreatorID
    • アクセスするコンジットのクリエイタ ID。
  • ← pUsaAction
    • UmSetSyncAction によって定義された同期設定を受け取るための long へのポインタ。

返り値

成功した場合、UmUserSyncAction の 1 つを返します。さらにこれは pUsaAction にも返されます。

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

  • -1
    • 特定されていないエラーが起こったか、指定されたクリエイタ ID に対してセットされた永久設定は存在しません。
  • ERR_UM_BAD_FILENAME
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SAVE_ERR
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmSetUserTempSyncPreferences(), UmRemoveUserTempSyncPreferences(), UmDeleteUserTempSyncPreferences()

UmIsInstallMaskSet 関数 ^TOP^

目的

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

宣言されている場所

UserData.h

Prototype

long UmIsInstallMaskSet (
   DWORD dwUserID,
   DWORD dwMask
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • → dwMask
    • あなたが実行ステータスを知ろうとしているインストール コンジットに関連付けされている 1 ビット マスク。

返り値

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

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

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

  • ERR_UM_BAD_FILENAME
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

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

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmSetInstallMask(), UmClearInstallMask()

UmIsUserInstalled 関数 ^TOP^

目的

指定されたユーザが「インストールされている」かどうかを決定します。

宣言されている場所

UserData.h

Prototype

long UmIsUserInstalled (
   DWORD dwUserID
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。

返り値

ユーザがインストールされているユーザである場合、true を返します。

ユーザがインストールされていないユーザである場合、false を返します。

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

  • ERR_UM_BAD_FILENAME
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

「インストールされている」ユーザとは、少なくとも 1 度は HotSync を完了していて、そのためにデスクトップ コンピュータとハンドヘルドの両方にそのユーザ ID が存在しているユーザです。デスクトップ上で作成されたが HotSync を完了したことのないユーザは「インストールされた」ユーザではありません。それらのユーザはデスクトップ上でのそれらのユーザ ID と同じユーザ ID を持つハンドヘルドと同期を行ったときに「インストールされた」ユーザになります。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmSetUserInstall()

UmIsUserNameValid 関数 ^TOP^

目的

提供された文字列が有効な HotSync ユーザ名であるかどうかを決定します。

宣言されている場所

UserData.h

Prototype

bool UmIsUserNameValid (
   const TCHAR *pUserName
)

パラメータ

  • → pUserName
    • 検証するユーザ名を保持している文字バッファへのポインタ。

返り値

ユーザ名が有効である場合、true を返します。

ユーザ名が無効である場合、false を返します。

コメント

この関数は提供されたユーザ名の以下の特性を検証します:

  • 少なくとも 1 個から 20 個までの有効な文字を保持している (pUserName が NULL であったり、空の文字列バッファを指している場合、ユーザ名は無効になります)。
  • 以下の無効な文字を保持していない:
    ~!@#$%^&*()`+=[]{}:";',<>?/|\
    ユーザ名はピリオド (.), ハイフン (-), アンダスコア (_) 文字を保持するかもしれません。
  • スペース文字ではない有効な文字を少なくとも 1 個は保持している。
  • マルチ バイト スペース文字で始まらない。ユーザ名はシングル バイト スペース文字で始まるかもしれません; しかしながら、これはこの関数の将来のバージョンでは許可されなくなるかもしれません。

新しいユーザを作成するためにユーザ名を UmAddUser() に渡す前にそのユーザ名を検証するためにこの関数を使用します。ユーザ名を検証すると、そのユーザ名が HotSync ログに現れるときに、そのログが誤ったフォーマットにならないようそのユーザ名が特別な HTML 文字を含まないことが保証されます。

互換性

  • ユーザ データ API バージョン: 4.2 よりも後のバージョン
  • Palm OS バージョン: すべて

参照

UmAddUser()

UmIsUserProfile 関数 ^TOP^

目的

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

宣言されている場所

UserData.h

Prototype

long UmIsUserProfile (
   DWORD dwUserID
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。

返り値

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

アカウントがユーザ プロファイルでない場合、false を返します。

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

  • ERR_UM_BAD_FILENAME
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

ユーザ プロファイル についての更なる情報は、Introduction to Conduit Development の用語集を参照してください。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID()

UmRemoveUserTempSyncPreferences 関数 ^TOP^

目的

指定されたユーザ ID の指定されたコンジットの一時同期設定を削除します。

宣言されている場所

UserData.h

Prototype

long UmRemoveUserTempSyncPreferences (
   DWORD dwUserID,
   DWORD dwCreatorID
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • → dwCreatorID
    • アクセスするコンジットのクリエイタ ID。

返り値

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

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

  • ERR_UM_BAD_FILENAME
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SAVE_ERR
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

UmRemoveUserTempSyncPreferences() は指定されたコンジットの一時同期設定をクリアし、それにより次の HotSync では永久同期セットにセットされているアクションがとられます。この関数の結果は、ユーザが HotSync マネージャの Custom > Change オプションをクリックしたことがなくコンジットの一時同期設定を変更したことがない場合と同じです。

NOTE
個の関数はただ 1 つだけのコンジットの一時同期設定をクリアします。この関数とは対照的に、UmDeleteUserTempSyncPreferences() はユーザのすべてのコンジットの一時同期設定をクリアします。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmSetUserTempSyncPreferences(), UmGetUserTempSyncPreferences(), UmDeleteUserTempSyncPreferences()

UmSetInstallMask 関数 ^TOP^

目的

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

宣言されている場所

UserData.h

Prototype

long UmSetInstallMask (
   DWORD dwUserID,
   DWORD dwMask
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • → dwMask
    • あなたが実行させようとしているインストール コンジットに関連付けされている 1 ビット マスク。

返り値

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

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

  • ERR_UM_BAD_FILENAME
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

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

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmIsInstallMaskSet(), UmClearInstallMask()

UmSetInteger 関数 ^TOP^

目的

ユーザ データ保存場所の指定されたユーザのエリアの中にあるキーに整数値をセットします。

宣言されている場所

UserData.h

Prototype

long UmSetInteger (
   DWORD dwUserID,
   const TCHAR *pszSection,
   const TCHAR *pszKey,
   long lValue
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • → pszSection
    • ユーザ データ保存場所の指定されたユーザのエリアの中にあるセクション名。
  • → pszKey
    • セットする整数のキー。
  • → lValue
    • ユーザ データ保存場所の指定されたユーザのキーに書き込む整数。

返り値

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

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

  • ERR_UM_BAD_FILENAME
  • ERR_UM_BUFSIZE_TOO_SMALL
  • ERR_UM_CANNOT_WRITE_TO_STORE
  • ERR_UM_INVALID_POINTER
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

提供されたセクションの名前とキーからユーザ データ保存場所の中にある整数キーの値をセットするためにこの関数を使用します。あなたはこの関数を使用してあなた自身のキーをクリアまたはセットすることができます。しかしながら、値をセットするためのユーザ データ API 関数が存在する場合、この汎用関数ではなくその専用関数を使用してください。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmGetInteger()

UmSetString 関数 ^TOP^

目的

ユーザ データ保存場所の指定されたユーザのエリアの中にあるキーに文字列値をセットします。

宣言されている場所

UserData.h

Prototype

long UmSetString (
   DWORD dwUserID,
   const TCHAR *pszSection,
   const TCHAR *pszKey,
   const TCHAR *pszValue
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • → pszSection
    • ユーザ データ保存場所の指定されたユーザのエリアの中にあるセクション名。
  • → pszKey
    • セットする文字列のキー。
  • → pszValue
    • ユーザ データ保存場所の指定されたユーザのキーに書き込む文字列。

返り値

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

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

  • ERR_UM_BAD_FILENAME
  • ERR_UM_BUFSIZE_TOO_SMALL
  • ERR_UM_CANNOT_WRITE_TO_STORE
  • ERR_UM_INVALID_POINTER
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

提供されたセクションの名前とキーからユーザ データ保存場所の中にある文字列キーの値をセットするためにこの関数を使用します。あなたはこの関数を使用してあなた自身のキーをクリアまたはセットすることができます。しかしながら、値をセットするためのユーザ データ API 関数が存在する場合、この汎用関数ではなくその専用関数を使用してください。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmGetString()

UmSetUserDirectory 関数 ^TOP^

目的

指定されたユーザ ID のディレクトリ名をセットします。

宣言されている場所

UserData.h

Prototype

long UmSetUserDirectory (
   DWORD dwUserID,
   const TCHAR *pUserDir
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • → pUserDir
    • セットするユーザ ディレクトリの名前を保持している文字バッファ。

返り値

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

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

  • ERR_UM_BAD_FILENAME
  • ERR_UM_INVALID_USER
  • ERR_UM_INVALID_USER_DIR
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SAVE_ERR
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS
  • ERR_UM_USER_DIR_ALREADY_IN_USE

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmGetUserDirectory()

UmSetUserInstall 関数 ^TOP^

目的

指定されたユーザ ID の "installed" (「インストールされた」) フラグをセットまたはクリアします。

宣言されている場所

UserData.h

Prototype

long UmSetUserInstall (
   DWORD dwUserID,
   BOOL bUserInstall
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • → bUserInstall
    • ブール値。これが true である場合、ユーザは「インストールされた」ユーザとしてセットされます; これが false である場合、ユーザは「インストールされた」ユーザではないとセットされます。

返り値

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

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

  • ERR_UM_BAD_FILENAME
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SAVE_ERR
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

「インストールされている」ユーザとは、少なくとも 1 度は HotSync を完了していて、そのためにデスクトップ コンピュータとハンドヘルドの両方にそのユーザ ID が存在しているユーザです。デスクトップ上で作成されたが HotSync を完了したことのないユーザは「インストールされた」ユーザではありません。それらのユーザはデスクトップ上でのそれらのユーザ ID と同じユーザ ID を持つハンドヘルドと同期を行ったときに「インストールされた」ユーザになります。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmIsUserInstalled()

UmSetUserName 関数 ^TOP^

目的

指定されたユーザ ID のユーザ名をセットします。

宣言されている場所

UserData.h

Prototype

long UmSetUserName (
   DWORD dwUserID,
   const char *pUserName
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • → pUserName
    • セットするユーザ名を保持している文字バッファ。

返り値

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

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

  • ERR_UM_BAD_FILENAME
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SAVE_ERR
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS
  • ERR_UM_USER_ALREADY_EXISTS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmGetUserName()

UmSetUserPermSyncPreferences 関数 ^TOP^

目的

指定されたユーザ ID のコンジットの永久同期設定をセットします。

宣言されている場所

UserData.h

Prototype

long UmSetUserPermSyncPreferences (
   DWORD dwUserID,
   DWORD dwCreatorID,
   long usaAction
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • → dwCreatorID
    • アクセスするコンジットのクリエイタ ID。
  • → usaAction
    • 実行する同期アクション。UmUserSyncAction 列挙値の 1 つを指定します。

返り値

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

設定をセットすることができなかった場合、false を返します。

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

  • ERR_UM_BAD_FILENAME
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SAVE_ERR
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmGetUserPermSyncPreferences(), UmDeleteUserPermSyncPreferences()

UmSetUserTempSyncPreferences 関数 ^TOP^

目的

指定されたユーザ ID のコンジットの一時同期設定をセットします。

宣言されている場所

UserData.h

Prototype

long UmSetUserTempSyncPreferences (
   DWORD dwUserID,
   DWORD dwCreatorID,
   long usaAction
)

パラメータ

  • → dwUserID
    • ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。
  • → dwCreatorID
    • アクセスするコンジットのクリエイタ ID。
  • → usaAction
    • 実行する同期アクション。UmUserSyncAction 列挙値の 1 つを指定します。

返り値

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

設定をセットすることができなかった場合、false を返します。

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

  • ERR_UM_BAD_FILENAME
  • ERR_UM_INVALID_USER
  • ERR_UM_NO_CORE_PATH
  • ERR_UM_NO_DIRECTORY
  • ERR_UM_NO_USER_FOUND
  • ERR_UM_NO_USERS
  • ERR_UM_NO_USERSDAT_FILE
  • ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM
  • ERR_UM_SAVE_ERR
  • ERR_UM_SEMAPHORE_ACCESS
  • ERR_UM_UNABLE_TO_CREATE_NEW_FILE
  • ERR_UM_USER_ACCESS

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

互換性

  • ユーザ データ API バージョン: すべて
  • Palm OS バージョン: すべて

参照

UmGetUserID(), UmGetUserTempSyncPreferences(), UmRemoveUserTempSyncPreferences(), UmDeleteUserTempSyncPreferences()

UmSlotGetDisplayName 関数 ^TOP^

目的

指定されたユーザのハンドヘルド上にある指定されたスロットの表示名を取得します。

宣言されている場所

UserData.h

Prototype

long UmSlotGetDisplayName (
   DWORD dwUserId,
   DWORD dwSlotId,
   TCHAR *pszSlotDisplayName,
   long *plSize
)

パラメータ

  • → dwUserID
    • ユーザ ID。
  • → dwSlotId
    • 名前を取得するスロットの ID。スロット ID を取得するには、ユーザ データ API の UmSlotGetInfo() 関数を使用します。
  • ← pszSlotDisplayName
    • 指定されたスロットの表示名を保持する文字バッファへのポインタ。この関数を呼び出す前にこのバッファに割り当てを行わなければなりません。
  • ←→ plSize
    • pszSlotDisplayName バッファのサイズを示す long へのポインタ。呼び出し時には、これはバッファに割り当てられたサイズを指します。返り時には、渡されたサイズが小さすぎた場合はあなたがバッファに割り当てなければならないバイト数を指します。

返り値

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

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

  • ERR_UM_INVALID_POINTER
  • ERR_UM_BUFSIZE_TOO_SMALL
  • ERR_UM_DEV_CFG_DATA_NOT_AVAILABLE

pszSlotDisplayName が表示名を保持するには小さすぎる場合、この関数は ERR_UM_BUFSIZE_TOO_SMALL を返し、必要とされるサイズを plSize に返します。

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

ユーザの利便性のためにスロットを特定するのにスロット ID ではなく、表示名を使用してください。

HotSync マネージャは各 HotSync の開始時にスロットにそのスロットのメディア タイプに基づく名前を割り当て、それをデスクトップ上のユーザ情報保存場所の中の対応するユーザのために保存します。この関数は単純に保存されている情報を返すだけです。そのため、ユーザはハンドヘルドを変更したり更新するかもしれないので、次の HotSync では正しい情報ではなくなるかもしれません。

あなたはこの関数や他のスロット関連のユーザ データ関数を呼び出す前に、ハンドヘルド上の拡張マネージャの存在 (とそのバージョン) をチェックするために UmSlotGetExpMgrVersion() を呼び出さなければなりません。

例

TCHAR szDisplayName [256]; 
long lSize = sizeof (szDisplayName); 
long retval = UmSlotGetDisplayName (dwUserId, dwSlotId,  
   szDisplayName, &lSize);

互換性

  • ユーザ データ API バージョン: 4.0 以降
  • Palm OS バージョン: 4.0 以降

参照

UmSlotGetInfo()

UmSlotGetExpMgrVersion 関数 ^TOP^

目的

指定されたユーザのハンドヘルドの拡張マネージャのバージョンを取得します。

宣言されている場所

UserData.h

Prototype

long UmSlotGetExpMgrVersion (
   DWORD dwUserId,
   DWORD *pdwExpMgrVersion
)

パラメータ

  • → dwUserID
    • ユーザ ID。
  • ← pdwExpMgrVersion
    • ハンドヘルド上の拡張マネージャのバージョンを保持する DWORD へのポインタ。拡張マネージャが存在しない場合、この値は 0 になります - この場合、他のスロット関連の関数を呼び出してはいけません。

返り値

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

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

  • ERR_UM_INVALID_POINTER
  • ERR_UM_DEV_CFG_DATA_NOT_AVAILABLE

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

HotSync マネージャは各 HotSync の開始時にスロットにそのスロットのメディア タイプに基づく名前を割り当て、それをデスクトップ上のユーザ情報保存場所の中の対応するユーザのために保存します。この関数は単純に保存されている情報を返すだけです。そのため、ユーザはハンドヘルドを変更したり更新するかもしれないので、次の HotSync では正しい情報ではなくなるかもしれません。

あなたは他のスロット関連のユーザ データ関数を呼び出す前に、ハンドヘルド上の拡張マネージャの存在 (とそのバージョン) をチェックするために UmSlotGetExpMgrVersion() を呼び出さなければなりません。

例

DWORD dwExpMgrVersion;  
long retval = UmSlotGetExpMgrVersion (dwUserId,  
   &dwExpMgrVersion);

互換性

  • ユーザ データ API バージョン: 4.0 以降
  • Palm OS バージョン: 4.0 以降

UmSlotGetInfo 関数 ^TOP^

目的

指定されたユーザのハンドヘルド上に存在する各拡張スロットのスロット ID を取得します。

宣言されている場所

UserData.h

Prototype

long UmSlotGetInfo (
   DWORD dwUserId,
   DWORD *pdwSlotIdList,
   WORD *pwNumEntries
)

パラメータ

  • → dwUserID
    • ユーザ ID。
  • ← pdwSlotIdList
    • 各スロットの ID を保持する DWORD 配列へのポインタ。
  • ←→ pwNumEntries
    • pdwSlotIdList 配列の中のエントリの数を示す DWORD へのポインタ。呼び出し時には、pdwSlotIdList 配列に割り当てられたエントリの数を指します。呼び出し元はまずスロット数を取得するために UmSlotGetSlotCount() を呼び出し、その数のエントリを割り当てるべきです。返り時には、ID No取得に成功したスロットの数を指します - これは実際に存在するスロットの数とは等しくないかもしれません。

返り値

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

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

  • ERR_UM_INVALID_POINTER
  • ERR_UM_DEV_CFG_DATA_NOT_AVAILABLE
  • ERR_UM_BUFSIZE_TOO_SMALL

pdwSlotIdList 配列が小さすぎる場合、この関数は ERR_UM_BUFSIZE_TOO_SMALL を返し、pwNumEntries に必要とされるサイズをセットします。

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

ハンドヘルド上の拡張マネージャはスロット参照番号によってスロットを識別します。これらのスロット参照番号はスロット ドライバが拡張マネージャによってロードされる順番によって変わるかもしれません。その上、スロット参照番号は HotSync の最中にコンジットのみが使用可能です。そのため、ユーザ データ API はスロットを識別するためにスロット参照番号の代わりにスロット ID を使用します。

HotSync マネージャは各 HotSync の開始時にハンドヘルド上のスロットにスロット ID を割り当て、それらをデスクトップ上のユーザ情報保存場所の中の対応するユーザのために保存します。この関数は単純に保存されている情報を返すだけです。そのため、ユーザはハンドヘルドを変更したり更新するかもしれないので、次の HotSync では正しい情報ではなくなるかもしれません。

あなたはこの関数や他のスロット関連のユーザ データ関数を呼び出す前に、ハンドヘルド上の拡張マネージャの存在 (とそのバージョン) をチェックするために UmSlotGetExpMgrVersion() を呼び出さなければなりません。

例

WORD wNumSlots;
DWORD *pdwSlotIdList;
   long retval = UmSlotGetSlotCount (dwUserId, &wNumSlots);
   if (retval == ERROR_SUCCESS)
   {
      pdwSlotIdList = new DWORD [wNumSlots];
      if (pdwSlotIdList)
      {
         UmSlotGetSlotInfo (dwUserId, pdwSlotIdList,
            wNumSlots);
      }
   }

互換性

  • ユーザ データ API バージョン: 4.0 以降
  • Palm OS バージョン: 4.0 以降

参照

UmSlotGetSlotCount(), UmSlotGetExpMgrVersion()

UmSlotGetInstallDirectory 関数 ^TOP^

目的

指定されたユーザとハンドヘルド スロットからスロット インストール ディレクトリ名 (フル パスではありません) を取得します。

宣言されている場所

UserData.h

Prototype

long UmSlotGetInstallDirectory (
   DWORD dwUserId,
   DWORD dwSlotId,
   TCHAR *pszSlotInstallDir,
   long *plSize
)

パラメータ

  • → dwUserID
    • ユーザ ID。
  • → dwSlotId
    • スロット インストール ディレクトリを取得するスロットの ID。スロット ID を取得するにはユーザ データ API の UmSlotGetInfo() 関数を使用します。
  • ← pszSlotInstallDir
    • 指定されたスロットのスロット インストール ディレクトリの名前を保持する文字バッファへのポインタ。この関数を呼び出す前にこのバッファに割り当てを行わなければなりません。
  • ←→ plSize
    • pszSlotInstallDir バッファのサイズを示す long へのポインタ。呼び出し時には、バッファに割り当てられたサイズを指します。返り時には、渡されたサイズが小さすぎた場合はあなたがバッファに割り当てなければならないバイト数を指します。

返り値

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

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

  • ERR_UM_INVALID_POINTER
  • ERR_UM_BUFSIZE_TOO_SMALL
  • ERR_UM_DEV_CFG_DATA_NOT_AVAILABLE

pszSlotInstallDir がディレクトリ名を保持するには小さすぎる場合、この関数は ERR_UM_BUFSIZE_TOO_SMALL を返し、plSize に必要とされるサイズを返します。

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

スロット インストール ディレクトリは、インストール援助機能が指定されたユーザのハンドヘルド上の対応するスロットにインストールするためにキューに追加されるファイルを置くデスクトップ上の場所です。

HotSync マネージャは各 HotSync の開始時にこの情報をデスクトップ上のユーザ情報保存場所の中の対応するユーザのために保存します。この関数は単純に保存されている情報を返すだけです。そのため、ユーザはハンドヘルドを変更したり更新するかもしれないので、次の HotSync では正しい情報ではなくなるかもしれません。ファイルがスロットにインストールされるためにキューに追加されていて、そのスロット情報が次の HotSync の最中に変更された場合、インストール コンジットはそのファイルを無視するかもしれませんが、スロット インストール ディレクトリ自体を削除することはしません。

あなたはこの関数や他のスロット関連のユーザ データ関数を呼び出す前に、ハンドヘルド上の拡張マネージャの存在 (とそのバージョン) をチェックするために UmSlotGetExpMgrVersion() を呼び出さなければなりません。

例

TCHAR szInstallDir [256]; 
long lSize = sizeof (szInstallDir); 
long retval = UmSlotGetInstallDirectory (dwUserId, dwSlotId,  
   szInstallDir, &lSize);

互換性

  • ユーザ データ API バージョン: 4.0 以降
  • Palm OS バージョン: 4.0 以降

参照

UmSlotGetInfo(), UmSlotGetExpMgrVersion(), C/C++ Sync Suite Companion の 「インストール ディレクトリ用語」

UmSlotGetMediaType 関数 ^TOP^

目的

指定されたユーザのハンドヘルドの指定されたスロットのメディア タイプを取得します。

宣言されている場所

UserData.h

Prototype

long UmSlotGetMediaType (
   DWORD dwUserId,
   DWORD dwSlotId,
   DWORD *pdwSlotMediaType
)

パラメータ

  • → dwUserID
    • ユーザ ID。
  • → dwSlotId
    • メディア タイプを取得するスロットの ID。スロット ID を取得するには、ユーザ データ API の UmSlotGetInfo() 関数を使用します。
  • ← pdwSlotMediaType
    • 指定されたスロットのメディア タイプを保持する DWORD へのポインタ。スロット メディア タイプは 「メディア タイプ定数」 で定義されています。

返り値

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

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

  • ERR_UM_INVALID_POINTER
  • ERR_UM_DEV_CFG_DATA_NOT_AVAILABLE

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

HotSync マネージャは各 HotSync の開始時にこの情報を取得し、それをデスクトップ上のユーザ情報保存場所の中の対応するユーザのために保存します。この関数は単純に保存されている情報を返すだけです。そのため、ユーザはハンドヘルドを変更したり更新するかもしれないので、次の HotSync では正しい情報ではなくなるかもしれません。

あなたはこの関数や他のスロット関連のユーザ データ関数を呼び出す前に、ハンドヘルド上の拡張マネージャの存在 (とそのバージョン) をチェックするために UmSlotGetExpMgrVersion() を呼び出さなければなりません。

例

DWORD dwSlotMediaType;
long retval = UmSlotGetMediaType (dwUserId, dwSlotId,
   &dwSlotMediaType);

互換性

  • ユーザ データ API バージョン: 4.0 以降
  • Palm OS バージョン: 4.0 以降

参照

UmSlotGetInfo(), UmSlotGetExpMgrVersion()

UmSlotGetSlotCount 関数 ^TOP^

目的

指定されたユーザのハンドヘルド上にある拡張スロットの数を取得します。

宣言されている場所

UserData.h

Prototype

long UmSlotGetSlotCount (
   DWORD dwUserId,
   WORD *pwNumSlots
)

パラメータ

  • → dwUserID
    • ユーザ ID。
  • ← pwNumSlots
    • ハンドヘルド上のスロットの数を保持する DWORD へのポインタ。ハンドヘルドが拡張スロットを持たない場合、このポインタが指す値は 0 になります。

返り値

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

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

  • ERR_UM_INVALID_POINTER
  • ERR_UM_DEV_CFG_DATA_NOT_AVAILABLE

ハンドヘルドがスロットを持たない場合、この関数は ERR_UM_DEV_CFG_DATA_NOT_AVAILABLE を返し、*pwNumSlot に 0 を返します。

すべてのユーザ データ API エラー コードについての説明は、「ユーザ データ API エラー コード」 を参照してください。

コメント

HotSync マネージャは各 HotSync の開始時にこの情報を取得し、それをデスクトップ上のユーザ情報保存場所の中の対応するユーザのために保存します。この関数は単純に保存されている情報を返すだけです。そのため、ユーザはハンドヘルドを変更したり更新するかもしれないので、次の HotSync では正しい情報ではなくなるかもしれません。

あなたはこの関数や他のスロット関連のユーザ データ関数を呼び出す前に、ハンドヘルド上の拡張マネージャの存在 (とそのバージョン) をチェックするために UmSlotGetExpMgrVersion() を呼び出さなければなりません。

例

WORD wNumSlots;
long retval = UmSlotGetSlotCount (dwUserId, &wNumSlots);

互換性

  • ユーザ データ API バージョン: 4.0 以降
  • Palm OS バージョン: 4.0 以降

参照

UmSlotGetExpMgrVersion()

ユーザ データ API エラー コード ^TOP^

表 16.1 はユーザ データ API 関数が返す可能性のあるエラー コードの値をリスト アップしています。各関数の説明でその関数が返す可能性のあるエラーについて述べています。

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


表 16.1 ユーザ データ API エラー コード

値 エラー コード 説明
0xFFFFFFFF ― 特定されていないエラーが起こりました。
0xFFFFFDED ERR_UM_NO_DEFAULT_USER デフォルト HotSync ユーザがセットされていないか、無効なユーザ ID がセットされています。このエラー コードは将来使用するために予約されています。
0xFFFFFDEE ERR_UM_MULTIPLE_USERS_EXISTS ユーザ データ保存場所の中に複数のユーザが存在します。このエラー コードは将来使用するために予約されています。
0xFFFFFDEF ERR_UM_DEV_CFG_DATA_NOT_AVAILABLE ハンドヘルドについてのリクエストされた情報は利用不可です - 例えば、指定されたユーザに対して以前に保存された拡張スロット情報がないためです。
0xFFFFFDF0 ERR_UM_FUNCTION_NOT_SUPPORTED この関数はもはやサポートされません。
0xFFFFFDF1 ERR_UM_STRING_TOO_BIG 取得しようとしている文字列は保存するには長すぎます。
0xFFFFFDF2 ERR_UM_SYNC_PATH_TOO_BIG このエラー コードを返す関数はありません。
0xFFFFFDF3 ERR_UM_CANNOT_WRITE_TO_STORE 指定されたユーザのユーザ データ保存場所の中のエリアへの書き込みは失敗しました。
0xFFFFFDF4 ERR_UM_USER_DIR_ALREADY_IN_USE 指定されたユーザ ディレクトリ名はすでに他のユーザによって使用されています。
0xFFFFFDF5 ERR_UM_USER_ALREADY_EXISTS 指定されたユーザはすでに存在します。
0xFFFFFDF6 ERR_UM_INVALID_POINTER 指定されたポインタは無効です。
0xFFFFFDF7 ERR_UM_NO_CORE_PATH Core\Path コンフィグレーション エントリの値は存在しません。UmGetRootDirectory() を参照してください。
0xFFFFFDF8 ERR_UM_UNABLE_TO_CREATE_NEW_FILE 新しいファイルの作成は失敗しました。
0xFFFFFDF9 ERR_UM_SEMAPHORE_ACCESS 指定されたユーザ インデックスは無効です。
0xFFFFFDFA ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM ユーザ データ保存場所にアクセスしようとしたときに未知のエラーが起こりました。
0xFFFFFDFB ERR_UM_BASE このエラー コードを返す関数はありません。
0xFFFFFDFC ERR_UM_SAVE_ERR 変更の保存は成功せずに完了しました。
0xFFFFFDFD ERR_UM_USER_ACCESS このユーザ データ関数はこのユーザ データにアクセスすることができません。
0xFFFFFDFE ERR_UM_BAD_FILENAME ユーザ データ関数に渡されたファイルは有効なファイル タイプではありません。
0xFFFFFDFF ERR_UM_NOT_FOUND このユーザ名パラメータはユーザ データ保存場所に含まれていません。
0xFFFFFE00 ERR_UM_NO_USER_FOUND このユーザはユーザ データ保存場所の中に存在しません。
0xFFFFFE01 ERR_UM_NO_DIRECTORY このユーザ ディレクトリは存在しません。
0xFFFFFE02 ERR_UM_INVALID_USER_DIR 指定されたユーザ ディレクトリは存在しません。
0xFFFFFE03 ERR_UM_INVALID_USER_NAME 指定されたユーザ名は無効です。
0xFFFFFE04 ERR_UM_INVALID_BUFFER このエラー コードを返す関数はありません。
0xFFFFFE05 ERR_UM_INVALID_INDEX このエラー コードを返す関数はありません。
0xFFFFFE06 ERR_UM_INVALID_REGISTRY ユーザ データ関数は無効なコンフィグレーション エントリを書き込もうとしました。
0xFFFFFE07 ERR_UM_INVALID_USER 提供されたユーザ ID はNULL であるか、利用可能なユーザのためのものではありません。
0xFFFFFE08 ERR_UM_BUFSIZE_TOO_SMALL 提供されたバッファはリクエストされた情報を保持するには小さすぎます。
0xFFFFFE09 ERR_UM_INVALID_USER_INDEX 渡されたユーザ インデックスは範囲外です。インデックスは 0 以上で、ユーザ データ保存場所の中にあるユーザの数よりも小さくなるべきです。
0xFFFFFE0A ERR_UM_USERSDAT_ALREADY_EXISTS このエラー コードを返す関数はありません。
0xFFFFFE0B ERR_UM_NO_USERS ユーザ データ保存場所は存在しますが、情報を保持していません。
0xFFFFFE0C ERR_UM_NO_USERSDAT_FILE ユーザ データ保存場所が見つかりません。このケースではたいていの関数は失敗します。新しい保存場所を作成するには UmAddUser() を呼び出します。

←　15 章に戻る　↑トップへ　17 章に進む　→

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

Index


メニュー

各種掲示板

検索

キーワード

Wiki

最新

2023/12/1

2021/4/5

2020/7/7

2020/5/15

2020/1/13

2019/4/1

2018/4/18

2018/4/17

Visitor:
[Today:]
[Yesterday:]