{{div_begin}} [[←　15 章に戻る|C/C++ Sync Suite Reference601/15]]　[[↑トップへ|C/C++ Sync Suite Reference601]]　[[17 章に進む　→|C/C++ Sync Suite Reference601/17]] {{div_end}} {{div_begin style="margin-bottom:-10px"}} !!!16 ユーザ データ API {{div_end}} {{div_begin "style='position:absolute;right:0px;font-size:70%;margin-right:15px;margin-top:15px;width:250px;'"}} *{{goto User Data API Versions,ユーザ データ API バージョン}} *{{goto User Data API Constants,ユーザ データ API 定数}} **{{goto UmUserSyncAction,UmUserSyncAction}} **{{goto Palm OS Version Section and Key Names,Palm OS バージョンのセクションとキー名}} **{{goto Version of the User Data API,ユーザ データ API のバージョン}} *{{goto User Data API Functions,ユーザ データ API 関数}} **{{goto UmAddUser,UmAddUser}} **{{goto UmClearInstallMask,UmClearInstallMask}} **{{goto UmDeleteKey,UmDeleteKey}} **{{goto UmDeleteUser,UmDeleteUser}} **{{goto UmDeleteUserPermSyncPreferences,UmDeleteUserPermSyncPreferences}} **{{goto UmDeleteUserTempSyncPreferences,UmDeleteUserTempSyncPreferences}} **{{goto UmGetIDFromName,UmGetIDFromName}} **{{goto UmGetIDFromPath,UmGetIDFromPath}} **{{goto UmGetInteger,UmGetInteger}} **{{goto UmGetLibVersion,UmGetLibVersion}} **{{goto UmGetRootDirectory,UmGetRootDirectory}} **{{goto UmGetString,UmGetString}} **{{goto UmGetUserCount,UmGetUserCount}} **{{goto UmGetUserDirectory,UmGetUserDirectory}} **{{goto UmGetUserID,UmGetUserID}} **{{goto UmGetUserName,UmGetUserName}} **{{goto UmGetUserPassword,UmGetUserPassword}} **{{goto UmGetUserPermSyncPreferences,UmGetUserPermSyncPreferences}} **{{goto UmGetUserTempSyncPreferences,UmGetUserTempSyncPreferences}} **{{goto UmIsInstallMaskSet,UmIsInstallMaskSet}} **{{goto UmIsUserInstalled,UmIsUserInstalled}} **{{goto UmIsUserNameValid,UmIsUserNameValid}} **{{goto UmIsUserProfile,UmIsUserProfile}} **{{goto UmRemoveUserTempSyncPreferences,UmRemoveUserTempSyncPreferences}} **{{goto UmSetInstallMask,UmSetInstallMask}} **{{goto UmSetInteger,UmSetInteger}} **{{goto UmSetString,UmSetString}} **{{goto UmSetUserDirectory,UmSetUserDirectory}} **{{goto UmSetUserInstall,UmSetUserInstall}} **{{goto UmSetUserName,UmSetUserName}} **{{goto UmSetUserPermSyncPreferences,UmSetUserPermSyncPreferences}} **{{goto UmSetUserTempSyncPreferences,UmSetUserTempSyncPreferences}} **{{goto UmSlotGetDisplayName,UmSlotGetDisplayName}} **{{goto UmSlotGetExpMgrVersion,UmSlotGetExpMgrVersion}} **{{goto UmSlotGetInfo,UmSlotGetInfo}} **{{goto UmSlotGetInstallDirectory,UmSlotGetInstallDirectory}} **{{goto UmSlotGetMediaType,UmSlotGetMediaType}} **{{goto UmSlotGetSlotCount,UmSlotGetSlotCount}} *{{goto User Data API Error Codes,ユーザ データ API エラー コード}} {{div_end}} {{div_begin "style='position:relative;padding:0px;padding-right:5px;padding-left:10px;margin-right:250px;margin-top:20px;width:auto;border-right-style:dotted;border-right-width:2px;border-right-color:silver;'"}} ユーザ データ API はデスクトップ コンピュータ上の {{goto user data store,ユーザ データ保存場所|Introduction to Conduit Development601/Glossary}} にアクセスします。ユーザ データ保存場所はカレント Windows ユーザによって作成されたすべてほ HotSync ユーザの名前、同期設定、ディレクトリ、パスワード情報を保持します。 ユーザ データ関数は {{span style='color:blue;font-family:monospace;',UserData.dll}} の中で利用可能であり、{{span style='color:blue;font-family:monospace;',UserData.h}} の中で宣言されています。 この章は以下の節に分かれています: *{{goto User Data API Versions,ユーザ データ API バージョン}} *{{goto User Data API Constants,ユーザ データ API 定数}} *{{goto User Data API Functions,ユーザ データ API 関数}} *{{goto User Data API Error Codes,ユーザ データ API エラー コード}} 更なる情報は、''C/C++ Sync Suite Companion'' の {{goto Using the User Data API,「ユーザ データ API の使用」|C/C++ Sync Suite Companion601/9-1}} を参照してください。 !!{{anchor User Data API Versions}}ユーザ データ API バージョン {{goto top,^TOP^}} ユーザ データ API は発展し続けて新しい関数と既存の関数の新しいバージョンを持ちます。バージョン 4.0 からは、ユーザ データ API の各バージョンはメジャ バージョン番号とマイナ バージョン番号を持ちます。あなたはユーザ データ API バージョン 4.0 以降で利用可能な {{goto UmGetLivVersion,UmGetLivVersion()}} を呼び出すことによって使用しているユーザ データ API のバージョンを決定することができます。それ以前のバージョンは {{span style='color:blue;font-family:monospace;',UmGetLivVersion()}} 関数を持ちません - これはバージョン 4.0 以降の機能を持っていないということを意味します。 ユーザ データ API はメジャ バージョン内で下位互換性を維持します。マイナ バージョン番号は新しい関数が追加されるか、バグが修正されたときに変更されます。このドキュメントは各関数に対してバージョン情報を示します。 あなたのアプリケーションがユーザ データ API のある特定のバージョンでのみ利用可能な関数に依存する場合、あなたはインストール時にあなたが扱っているユーザ データ API のバージョンを決定する必要があります。バージョンを決定するには、{{goto UmGetLivVersion,UmGetLivVersion()}} 関数を呼び出します。この関数はデスクトップ コンピュータ上のユーザ データ API のメジャ バージョン番号とマイナ バージョン番号の両方を返します。 例えば、あなたのアプリケーションがユーザ データ API のバージョン 4.0 で追加された関数に依存する場合、あなたは {{span style='color:blue;font-family:monospace;',UmGetLibVersion()}} を呼び出し、それからメジャ バージョン番号が 4 以上でありマイナ バージョン番号が 0 以上であることを確認する必要があります。 ユーザ データ API の新しい Feature とその他の変更点についての要約は、[[付録 A 「改訂履歴」|C/C++ Sync Suite Reference601/A]] を参照してください。 !!{{anchor User Data API Constants}}ユーザ データ API 定数 {{goto top,^TOP^}} この節では、あなたがユーザ データ API で使用する以下の列挙定数とプロセッサ定数のグループについて説明します。 ,定数,説明 ,"{{goto UmUserSyncAction,UmUserSyncAction}}",ある特定のコンジットで実行される同期のタイプを決定するユーザ設定を定義します。 ,"{{goto Palm OS Version Section and Key Names,Palm OS バージョンのセクションとキー名}}",ユーザ データ保存場所の中にあるセクションとキー名を定義します。これらはハンドヘルドの Palm OS バージョン番号が保存されている場所を指定します。 ,"{{goto Version of the User Data API,ユーザ データ API のバージョン}}","{{goto UmGetLibVersion,UmGetLibVersion()}} が返すユーザ データ API のバージョンを定義します。" !{{anchor UmUserSyncAction}}UmUserSyncAction 列挙体 {{goto top,^TOP^}} '''目的''' ある特定のコンジットで実行される同期のタイプを決定するユーザ設定を定義します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''定数''' *{{span style='color:blue;font-family:monospace;',Synchronize = 0}} **デスクトップ コンピュータとハンドヘルド間でミラー イメージ同期を実行します。 *{{span style='color:blue;font-family:monospace;',PCToHH}} **デスクトップ コンピュータからのリストアを実行します: ハンドヘルド上のデータベースをデスクトップ コンピュータ上のデータベースで上書きします。 *{{span style='color:blue;font-family:monospace;',HHToPC}} **ハンドヘルドからのリストアを実行します: デスクトップ コンピュータ上のデータベースをハンドヘルド上のデータベースで上書きします。 *{{span style='color:blue;font-family:monospace;',DoNothing}} **ハンドヘルドとデスクトップ コンピュータ間でデータの交換を行いません。しかしながら、HotSync マネージャはコンジットをロードします。ロードされたコンジットはフラグ、ログ メッセージをセットしたり、必要に応じてその他のハウスキーピング (訳者: 本来は家事のこと。データの整理をすることなどを意味するらしい。) を行うことができます。 *{{span style='color:blue;font-family:monospace;',Custom}} **コンジットに実装されているカスタム アクションを実行します。HotSync マネージャはこのフラグをコンジットに渡すだけであり、コンジットが実行するアクションを決定しなければなりません。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserPermSyncPreferences,UmGetUserPermSyncPreferences()}}, {{goto UmGetUserTempSyncPreferences,UmGetUserTempSyncPreferences()}}, {{goto UmSetUserPermSyncPreferences,UmSetUserPermSyncPreferences()}}, {{goto UmSetUserTempSyncPreferences,UmSetUserTempSyncPreferences()}} !{{anchor Palm OS Version Section and Key Names}}Palm OS バージョンのセクションとキー名 {{goto top,^TOP^}} '''目的''' ユーザ データ保存場所の中にあるセクションとキー名を定義します。これらはハンドヘルドの Palm OS バージョン番号が保存されている場所を指定します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''定数''' *{{span style='color:blue;font-family:monospace;',"#define DEVICE_INFO_SECTION_NAME \"Device Information\""}} **ユーザのハンドヘルドについての情報を保持しているユーザ データ保存場所のセクションを指定します。 *{{span style='color:blue;font-family:monospace;',"#define DEVICE_ROM_VERSION \"RomVersion\""}} **{{span style='color:blue;font-family:monospace;',DEVICE_INFO_SECTION_NAME}} セクションの中のキーを指定します。この値はユーザのハンドヘルド上の Palm OS のバージョンを定義します。 '''コメント''' HotSync マネージャ バージョン 6.0 以降はユーザのハンドヘルドとユーザ データ保存場所から Palm OS のバージョンを取得します。そのため、あなたは HotSync を実施していないときにも Palm OS のバージョンを取得することができます。この値を取得するには、{{goto UmGetInteger,UmGetInteger()}} を呼び出し、上記のセクションとキー名を指定します。それから {{goto SYNCROMVMAJOR,SYNCROMVMAJOR()|C/C++ Sync Suite Reference601/5-2}} マクロと {{goto SYNCROMVMINOR,SYNCROMVMINOR()|C/C++ Sync Suite Reference601/5-2}} マクロを使ってバージョン番号をデコードします。 '''互換性''' *ユーザ データ API バージョン: バージョン 4.2 よりも後 *Palm OS バージョン:すべて '''参照''' {{goto UmGetString,UmGetString()}}, {{goto UmSetString,UmSetString()}} !{{anchor Version of the User Data API}}ユーザ データ API のバージョン {{goto top,^TOP^}} '''目的''' {{goto UmGetLibVersion,UmGetLibVersion()}} が返すユーザ データ API のバージョンを定義します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''定数''' *{{span style='color:blue;font-family:monospace;',#define UM_LIB_VER_MAJOR 4}} **メジャ バージョン番号を意味します。 *{{span style='color:blue;font-family:monospace;',#define UM_LIB_VER_MINOR 2}} **マイナ バージョン番号を意味します。 '''コメント''' ユーザ データ API のバージョン 4.1 以降はこれらの値を定義します。これらの値は {{goto UmGetLibVersion,UmGetLibVersion()}} が返します。バージョン 4.0 では、これらの値は定義されていません。しかしながら、{{goto UmGetLibVersion,UmGetLibVersion()}} はメジャ バージョン番号として 4 を、マイナ バージョン番号として 0 を返すため、最初のバージョン番号 (訳者: メジャ バージョン番号) は利用可能です。 '''互換性''' *ユーザ データ API バージョン: 4.1 以降 *Palm OS バージョン: すべて '''参照''' {{goto UmGetLibVersion,UmGetLibVersion()}} !!{{anchor User Data API Functions}}ユーザ データ API 関数 {{goto top,^TOP^}} この節では、アプリケーションとコンジットがユーザ データ保存場所にアクセスするために使用することができある以下の関数について説明します。 ,関数,説明 ,"{{goto UmAddUser,UmAddUser()}}",ユーザをユーザ データ保存場所に追加します。 ,"{{goto UmClearInstallMask,UmClearInstallMask()}}",次の HotSync の最中に指定されたユーザのために実行することになっている指定されたインストール コンジットの選択を解除します。 ,"{{goto UmDeleteKey,UmDeleteKey()}}",ユーザ データ保存場所の指定されたユーザのエリアからキーまたはセクション全体を削除します。 ,"{{goto UmDeleteUser,UmDeleteUser()}}",ユーザ データ保存場所からユーザを削除します。 ,"{{goto UmDeleteUserPermSyncPreferences,UmDeleteUserPermSyncPreferences()}}",指定されたユーザのすべてのコンジットの永久同期設定を削除します。 ,"{{goto UmDeleteUserTempSyncPreferences,UmDeleteUserTempSyncPreferences()}}",指定されたユーザのすべてのコンジットの一時同期設定を削除します。 ,"{{goto UmGetIDFromName,UmGetIDFromName()}}",与えられたユーザの名前からユーザ ID を取得します。 ,"{{goto UmGetIDFromPath,UmGetIDFromPath()}}",与えられたユーザ ディレクトリからユーザ ID を取得します。 ,"{{goto UmGetInteger,UmGetInteger()}}",ユーザ データ保存場所の指定されたユーザのエリアの中にあるキーから整数値を取得します。 ,"{{goto UmGetLibVersion,UmGetLibVersion()}}",ユーザ データ API のバージョンを取得します。 ,"{{goto UmGetRootDirectory,UmGetRootDirectory()}}","デスクトップ コンピュータ上のすべてのユーザ ディレクトリのパス ({{span style='color:blue;font-family:monospace;',Core\Path}} コンフィグレーション エントリに保存されている) を取得します。" ,"{{goto UmGetString,UmGetString()}}",ユーザ データ保存場所の指定されたユーザのエリアの中にあるキーから文字列値を取得します。 ,"{{goto UmGetUserCount,UmGetUserCount()}}",ユーザ データ保存場所の中に存在するユーザの数を返します。 ,"{{goto UmGetUserDirectory,UmGetUserDirectory()}}",指定されたユーザ ID のユーザ ディレクトリの名前を取得します。 ,"{{goto UmGetUserID,UmGetUserID()}}",インデックスによってユーザ データ保存場所からユーザ ID を返します。 ,"{{goto UmGetUserName,UmGetUserName()}}",与えられたユーザ ID からユーザ データ保存場所の中に存在するユーザ名を取得します。 ,"{{goto UmGetUserPassword,UmGetUserPassword()}}",指定されたユーザ ID から暗号化されたユーザ パスワードを取得します。 ,"{{goto UmGetUserPermSyncPreferences,UmGetUserPermSyncPreferences()}}",指定されたユーザ ID からコンジットの永久同期設定を取得します。 ,"{{goto UmGetUserTempSyncPreferences,UmGetUserTempSyncPreferences()}}",指定されたユーザ ID からコンジットの一時同期設定を取得します。 ,"{{goto UmIsInstallMaskSet,UmIsInstallMaskSet()}}",指定されたインストール コンジットが次の HotSync の最中に指定されたユーザのために実行されるようにセットされているかどうかを決定します。 ,"{{goto UmIsUserInstalled,UmIsUserInstalled()}}",指定されたユーザが「インストールされている」かどうかを決定します。 ,"{{goto UmIsUserNameValid,UmIsUserNameValid()}}",提供された文字列が有効な HotSync ユーザ名であるかどうかを決定します。 ,"{{goto UmIsUserProfile,UmIsUserProfile()}}",アカウントがユーザ プロファイルであるかどうかを決定します。 ,"{{goto UmRemoveUserTempSyncPreferences,UmRemoveUserTempSyncPreferences()}}",指定されたユーザ ID の指定されたコンジットの一時同期設定を削除します。 ,"{{goto UmSetInstallMask,UmSetInstallMask()}}",指定されたインストール コンジットを次の HotSync の最中に指定されたユーザのために実行するよう選択します。 ,"{{goto UmSetInteger,UmSetInteger()}}",ユーザ データ保存場所の指定されたユーザのエリアの中にあるキーに整数値をセットします。 ,"{{goto UmSetString,UmSetString()}}",ユーザ データ保存場所の指定されたユーザのエリアの中にあるキーに文字列値をセットします。 ,"{{goto UmSetUserDirectory,UmSetUserDirectory()}}",指定されたユーザ ID のディレクトリ名をセットします。 ,"{{goto UmSetUserInstall,UmSetUserInstall()}}",指定されたユーザ ID の "installed" (「インストールされた」) フラグをセットまたはクリアします。 ,"{{goto UmSetUserName,UmSetUserName()}}",指定されたユーザ ID のユーザ名をセットします。 ,"{{goto UmSetUserPermSyncPreferences,UmSetUserPermSyncPreferences()}}",指定されたユーザ ID のコンジットの永久同期設定をセットします。 ,"{{goto UmSetUserTempSyncPreferences,UmSetUserTempSyncPreferences()}}",指定されたユーザ ID のコンジットの一時同期設定をセットします。 ,"{{goto UmSlotGetDisplayName,UmSlotGetDisplayName()}}",指定されたユーザのハンドヘルド上にある指定されたスロットの表示名を取得します。 ,"{{goto UmSlotGetExpMgrVersion,UmSlotGetExpMgrVersion()}}",指定されたユーザのハンドヘルドの拡張マネージャのバージョンを取得します。 ,"{{goto UmSlotGetInfo,UmSlotGetInfo()}}",指定されたユーザのハンドヘルド上に存在する各拡張スロットのスロット ID を取得します。 ,"{{goto UmSlotGetInstallDirectory,UmSlotGetInstallDirectory()}}",指定されたユーザとハンドヘルド スロットからスロット インストール ディレクトリ名 (フル パスではありません) を取得します。 ,"{{goto UmSlotGetMediaType,UmSlotGetMediaType()}}",指定されたユーザのハンドヘルドの指定されたスロットのメディア タイプを取得します。 ,"{{goto UmSlotGetSlotCount,UmSlotGetSlotCount()}}",指定されたユーザのハンドヘルド上にある拡張スロットの数を取得します。 !{{anchor UmAddUser}}UmAddUser 関数 {{goto top,^TOP^}} '''目的''' ユーザをユーザ データ保存場所に追加します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmAddUser ( const char *pUser, BOOL bProfileUser ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ pUser}} **追加するユーザの名前を指定する文字バッファへのポインタ。 *{{span style='color:blue;font-family:monospace;',→ bProfileUser}} **これが {{span style='color:blue;font-family:monospace;',true}} である場合、この関数は {{span style='color:blue;font-family:monospace;',pUser}} で指定された名前を持つ新しい {{goto user profile,ユーザ プロファイル|Introduction to Conduit Development601/Glossary}} を作成します。{{span style='color:blue;font-family:monospace;',false}} である場合、通常のユーザ アカウントを作成します。 '''返り値''' 成功した場合、0 を返します。ユーザ データ保存場所が存在しない場合、この関数は保存場所を作成し、ユーザを追加し、それらが成功した場合に 0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER_NAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SAVE_ERR}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ALREADY_EXISTS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' ユーザ名をこの関数に渡す前に、{{goto UmIsUserNameValid,UmIsUserNameValid()}} を呼び出してユーザ名が有効であるかどうか検証してください。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmIsUserNameValid,UmIsUserNameValid()}}, {{goto UmIsUserProfile,UmIsUserProfile()}}, {{goto UmDeleteUser,UmDeleteUser()}} !{{anchor UmClearInstallMask}}UmClearInstallMask 関数 {{goto top,^TOP^}} '''目的''' 次の HotSync の最中に指定されたユーザのために実行することになっている指定されたインストール コンジットの選択を解除します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmClearInstallMask ( DWORD dwUserID, DWORD dwMask ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',→ dwMask}} **あなたが実行されないようにしようとしているインストール コンジットに関連付けされている 1 ビット マスク。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' HotSync の最中に、HotSync マネージャはあなたが提供する {{span style='color:blue;font-family:monospace;',dwMask}} ビット マスク (これはあなたが指定されたユーザのために実行させなくするインストール コンジットに対応するものです) とコンフィグレーション エントリの中に保存されているすべてのインストール コンジットのビット マスクと XOR をとります。結果は指定されたユーザの "Install" コンフィグレーション エントリの中に保存されます。この関数の結果として、"Install" エントリの中のビットがクリアされ、それにより対応するインストール コンジットは次の HotSync の最中に指定されたユーザのために実行されることがなくなります。あなたが {{span style='color:blue;font-family:monospace;',dwMask}} の値を知らない場合、各インストール コンジットの {{span style='color:blue;font-family:monospace;',dwMask}} 値を取得するために {{goto PltGetInstallConduitInfo,PltGetInstallConduitInfo()|C/C++ Sync Suite Reference601/15}} を呼び出してください。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmSetInstallMask,UmSetInstallMask()}}, {{goto UmIsInstallMaskSet,UmIsInstallMaskSet()}} !{{anchor UmDeleteKey}}UmDeleteKey 関数 {{goto top,^TOP^}} '''目的''' ユーザ データ保存場所の指定されたユーザのエリアからキーまたはセクション全体を削除します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmDeleteKey ( DWORD dwUserID, const TCHAR *pszSection, const TCHAR *pszKey ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',→ pszSection}} **ユーザ データ保存場所の指定されたエリアの中にあるセクション名。 *{{span style='color:blue;font-family:monospace;',→ pszKey}} **削除するキー。これが {{span style='color:blue;font-family:monospace;',NULL}} である場合、セクション全体が削除されます。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します。特に、この関数がキーまたはセクションを削除できない場合、{{span style='color:blue;font-family:monospace;',ERR_UM_CANNOT_WRITE_TO_STORE}} を返します。 *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_BUFSIZE_TOO_SMALL}} *{{span style='color:blue;font-family:monospace;',ERR_UM_CANNOT_WRITE_TO_STORE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}} !{{anchor UmDeleteUser}}UmDeleteUser 関数 {{goto top,^TOP^}} '''目的''' ユーザ データ保存場所からユーザを削除します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmDeleteUser ( DWORD dwUserID ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 '''返り値''' 成功した場合、を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SAVE_ERR}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ALREADY_EXISTS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_DIR_ALREADY_IN_USE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmAddUser,UmAddUser()}} !{{anchor UmDeleteUserPermSyncPreferences}}UmDeleteUserPermSyncPreferences 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザのすべてのコンジットの永久同期設定を削除します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmDeleteUserPermSyncPreferences ( DWORD dwUserID, DWORD dwCreatorID ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',→ dwCreatorID}} **この値は無視されます。 '''返り値''' 成功した場合、を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SAVE_ERR}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' {{span style='color:blue;font-family:monospace;',UmDeleteUserPermSyncPreferences()}} はすべてのコンジットの永久同期設定をクリアします。結果はユーザが HotSync マネージャの '''Custom''' > '''Change''' オプションをクリックして永久同期設定を変更していない場合と同じになります。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmSetUserPermSyncPreferences,UmSetUserPermSyncPreferences()}}, {{goto UmGetUserPermSyncPreferences,UmGetUserPermSyncPreferences()}} !{{anchor UmDeleteUserTempSyncPreferences}}UmDeleteUserTempSyncPreferences 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザのすべてのコンジットの一時同期設定を削除します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmDeleteUserTempSyncPreferences ( DWORD dwUserID, DWORD dwCreatorID ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',→ dwCreatorID}} **この値は無視されます。 '''返り値''' 成功した場合、を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SAVE_ERR}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' {{span style='color:blue;font-family:monospace;',UmDeleteUserTempSyncPreferences()}} はすべてのコンジットの一時同期設定をクリアし、それにより次の HotSync ではコンジットの永久同期設定にセットされているアクション セットが実行されます。結果はユーザが HotSync マネージャの '''Custom''' > '''Change''' オプションをクリックして一時同期設定を変更していない場合と同じになります。 ::NOTE :::この関数はすべてのコンジットの一時同期設定をクリアします。これとは対照的に {{goto UmRemoveUserTempSyncPreferences,UmRemoveUserTempSyncPreferences()}} は 1 つだけのコンジットの一時同期設定をクリアします。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmSetUserTempSyncPreferences,UmSetUserTempSyncPreferences()}}, {{goto UmGetUserTempSyncPreferences,UmGetUserTempSyncPreferences()}}, {{goto UmRemoveUserTempSyncPreferences,UmRemoveUserTempSyncPreferences()}} !{{anchor UmGetIDFromName}}UmGetIDFromName 関数 {{goto top,^TOP^}} '''目的''' 与えられたユーザの名前からユーザ ID を取得します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmGetIDFromName ( const TCHAR *pszName, DWORD *pdwUserID ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ pszName}} **ユーザ名を保持している文字バッファへのポインタ。 *{{span style='color:blue;font-family:monospace;',← pdwUserID}} **ユーザ ID を受け取るバッファ。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',EE_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',EE_UM_BUFSIZE_TOO_SMALL}} *{{span style='color:blue;font-family:monospace;',EE_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',EE_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',EE_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',EE_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',EE_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' ユーザ データ保存場所は同じ名前を保持している可能性があります。ユーザ データ API が固有であると保証するのはユーザ ID だけであるので、同じ名前を持つ各インスタンスは異なるユーザ ID を持ちます。それゆえ、同じ名前を持つインスタンスがある場合、あなたはユーザ名が固有であるかどうか決定するために追加のチェックを行わなければなりません。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}} !{{anchor UmGetIDFromPath}}UmGetIDFromPath 関数 {{goto top,^TOP^}} '''目的''' 与えられたユーザ ディレクトリからユーザ ID を取得します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmGetIDFromPath ( const TCHAR *pszPath, DWORD *pdwUserID ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ pszPath}} **ユーザ ディレクトリへのパスを保持している文字バッファへのポインタ。 *{{span style='color:blue;font-family:monospace;',← pdwUserID}} **ユーザ ID を受け取るバッファ。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',EE_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',EE_UM_BUFSIZE_TOO_SMALL}} *{{span style='color:blue;font-family:monospace;',EE_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',EE_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',EE_UM_INVALID_USER_DIR}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',EE_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',EE_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',EE_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',EE_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}} !{{anchor UmGetInteger}}UmGetInteger 関数 {{goto top,^TOP^}} '''目的''' ユーザ データ保存場所の指定されたユーザのエリアの中にあるキーから整数値を取得します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmGetInteger ( DWORD dwUserID, const TCHAR *pszSection, const TCHAR *pszKey, long *pBuf, long lDefault ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',→ pszSection}} **ユーザ データ保存場所の指定されたユーザのエリアの中にあるセクション名。 *{{span style='color:blue;font-family:monospace;',→ pszKey}} **受け取る整数のキー。 *{{span style='color:blue;font-family:monospace;',← pBuf}} **整数を受け取るバッファ。 *{{span style='color:blue;font-family:monospace;',→ lDefault}} **指定されたキーに対して何の整数も受け取れなかった場合に返されるデフォルトの整数値。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返し、{{span style='color:blue;font-family:monospace;',pBuf}} に {{span style='color:blue;font-family:monospace;',lDefault}} で指定された値をセットします。 *{{span style='color:blue;font-family:monospace;',EE_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',EE_UM_BUFSIZE_TOO_SMALL}} *{{span style='color:blue;font-family:monospace;',EE_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',EE_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',EE_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',EE_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',EE_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',EE_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' 与えられたセクションの名前とキーによってユーザ データ保存場所の中にある整数キーの値を読み込むためにこの関数を使用します。あなたはこの関数を使ってあなたが作成したキーを読み込むことができます。しかしながら、値を読み込むためのユーザ データ API 関数が存在している場合、この汎用関数ではなく、その専用関数を使用してください。 HotSync マネージャ バージョン 6.0 以降はユーザのハンドヘルドから Palm OS のバージョンを取得し、それをユーザ データ保存場所に保存します。ユーザ データ API はその Palm OS バージョン番号を読み込むための専用関数を提供していないため、バージョン番号を読み込むにはこの関数を使用して {{goto Palm OS Version Section and Key Names,「Palm OS バージョンのセクションとキー名」}} で説明されているセクションとキー名を渡す必要があります。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmSetInteger,UmSetInteger()}} !{{anchor UmGetLibVersion}}UmGetLibVersion 関数 {{goto top,^TOP^}} '''目的''' ユーザ データ API のバージョンを取得します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmGetLibVersion ( DWORD *pdwMajor, DWORD *pdwMinor ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',← pdwMajor}} **メジャ バージョン番号。これは {{span style='color:blue;font-family:monospace;',UM_LIB_VER_MAJOR}} によって定義されています。 *{{span style='color:blue;font-family:monospace;',← pdwMinor}} **マイナ バージョン番号。これは {{span style='color:blue;font-family:monospace;',UM_LIB_VER_MINOR}} によって定義されています。 '''返り値''' 常に 0 を返します。 '''コメント''' ユーザ データ API 関数を呼び出す前にあなたが使用しているユーザ データ API のバージョンを決定するために {{span style='color:blue;font-family:monospace;',UmGetLibVersion()}} を呼び出します。更なる情報は、{{goto User Data API Versions,「ユーザ データ API バージョン」}} を参照してください。バージョン間で行われた変更についての詳細は、[[付録 A 「改訂履歴」|C/C++ Sync Suite Reference601/A]] を参照してください。 この関数が返すバージョン番号定数は {{goto Version of the User Data API,「ユーザ データ API のバージョン」}} で定義されています。 '''互換性''' *ユーザ データ API バージョン: 4.0 以降 *Palm OS バージョン: すべて !{{anchor UmGetRootDirectory}}UmGetRootDirectory 関数 {{goto top,^TOP^}} '''目的''' デスクトップ コンピュータ上のすべてのユーザ ディレクトリのパス ({{goto Core\Path 3,Core\Path|Introduction to Conduit Development601/A}} コンフィグレーション エントリに保存されている) を取得します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmGetRootDirectory ( TCHAR *pRootDirBuffer, short *psRootDirBufSize ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',← pRootDirBuffer}} **パスが返される文字バッファへのポインタ。 *{{span style='color:blue;font-family:monospace;',← psRootDirBufSize}} **パスのサイズが返される {{span style='color:blue;font-family:monospace;',short}} へのポインタ。 '''返り値''' 成功した場合、ルート パスの長さである 0 よりも大きな値を返します。さらに、同じ長さの値が {{span style='color:blue;font-family:monospace;',psRootDirBuffer}} に保存されます。 ルート パスが見つからなかった場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します。バッファがルート パスを保持するのに十分な大きさがない場合、この関数は {{span style='color:blue;font-family:monospace;',psRootDirBufSize}} に必要とされるサイズをセットし、エラー {{span style='color:blue;font-family:monospace;',ERR_UM_BUFSIZE_TOO_SMALL}} を返します。 *{{span style='color:blue;font-family:monospace;',EE_UM_BUFSIZE_TOO_SMALL}} *{{span style='color:blue;font-family:monospace;',EE_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',EE_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',EE_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',EE_UM_UNABLE_TO_CREATE_NEW_FILE}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' {{span style='color:blue;font-family:monospace;',UmGetRootDirectory()}} は {{goto Core\Path 3,Core\Path|Introduction to Conduit Development601/A}} コンフィグレーション エントリの中に保存されている値を取得します。HotSync マネージャ バージョン 6.0 以降は複数の Windows ユーザを認識するため、各 Windows ユーザは別個の {{span style='color:blue;font-family:monospace;',Core\Path}} 値を持たなければなりません。Windows の標準のユーザ データの置き場所に合わせると、通常は {{span style='color:blue;font-family:monospace;',C:\Documents and Settings\\My Documents\Palm OS Desktop}} になります。あなたが HotSync ユーザのディレクトリのフル パスを必要とする場合、{{goto UmGetUserDirectory,UmGetUserDirectory()}} を呼び出し、それによって得られたパスを {{span style='color:blue;font-family:monospace;',Core\Path}} 値に付加します。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserDirectory,UmGetUserDirectory()}}, {{goto UmSetUserDirectory,UmSetUserDirectory()}} !{{anchor UmGetString}}UmGetString 関数 {{goto top,^TOP^}} '''目的''' ユーザ データ保存場所の指定されたユーザのエリアの中にあるキーから文字列値を取得します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmGetString ( DWORD dwUserID, const TCHAR *pszSection, const TCHAR *pszKey, TCHAR *pBuf, long *lSize, const TCHAR *pszDefault ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',→ pszSection}} **ユーザ データ保存場所の指定されたユーザのエリアの中にあるセクション名。 *{{span style='color:blue;font-family:monospace;',→ pszKey}} **取得する文字列のキー。 *{{span style='color:blue;font-family:monospace;',← pBuf}} **文字列を受け取るためのバッファ。 *{{span style='color:blue;font-family:monospace;',←→ lSize}} **{{span style='color:blue;font-family:monospace;',pBuf}} によって参照されるバッファのサイズ (バイト数) を指定する {{span style='color:blue;font-family:monospace;',long}} 値へのポインタ。返り時には、この値は {{span style='color:blue;font-family:monospace;',pBuf}} の実際のサイズになります。バッファが小さすぎたためにこの関数が失敗した場合、返り時の {{span style='color:blue;font-family:monospace;',lpSize}} の値は文字列を保持するのに必要とされるサイズになります。 *{{span style='color:blue;font-family:monospace;',→ pszDefault}} **指定されたキーに対して文字列を取得することができなかった場合に返されるデフォルトの文字列。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します。バッファが文字列を保持するのに十分な大きさを持っていない場合、この関数は {{span style='color:blue;font-family:monospace;',lpSize}} を必要とされるサイズにセットし、エラー コード {{span style='color:blue;font-family:monospace;',ERR_UM_BUFSIZE_TOO_SMALL}} を返します。文字列を取得することができなかった場合、{{span style='color:blue;font-family:monospace;',pszDefault}} が {{span style='color:blue;font-family:monospace;',pBuf}} に返されます。 *{{span style='color:blue;font-family:monospace;',EE_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',EE_UM_BUFSIZE_TOO_SMALL}} *{{span style='color:blue;font-family:monospace;',EE_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',EE_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',EE_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',EE_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',EE_UM_STRING_TOO_BIG}} *{{span style='color:blue;font-family:monospace;',EE_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',EE_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' 与えられたセクション名とキーによってユーザ データ保存場所の中にある文字列キーの値を読み込むためにこの関数を使用します。あなたはこの関数を使用してあなたが作成したキーを読み込むことができます。しかしながら、値を読み込むためのユーザ データ API 関数が存在する場合、この汎用関数ではなくその専用関数を使用してください。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmSetString,UmSetString()}} !{{anchor UmGetUserCount}}UmGetUserCount 関数 {{goto top,^TOP^}} '''目的''' ユーザ データ保存場所の中に存在するユーザの数を返します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' short UmGetUserCount ( void ) '''パラメータ''' ありません。 '''返り値''' 成功した場合、ユーザ データ保存場所の中に存在するユーザの数である 0 以上の値を返します。 失敗した場合、以下のエラー コード値の 1 つである 0 より小さな値を返します: *{{span style='color:blue;font-family:monospace;',EE_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',EE_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',EE_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',EE_UM_UNABLE_TO_CREATE_NEW_FILE}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて !{{anchor UmGetUserDirectory}}UmGetUserDirectory 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザ ID のユーザ ディレクトリの名前を取得します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmGetUserDirectory ( DWORD dwUserID, TCHAR *pUserDirBuffer, short *psUserDirBufSize ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',← pUserDirBuffer}} **{{span style='color:blue;font-family:monospace;',TCHAR}} バッファへのポインタ。返り時に、このバッファは指定されたユーザのディレクトリ名を保持しています。 *{{span style='color:blue;font-family:monospace;',←→ psUserDirBufSize}} **{{span style='color:blue;font-family:monospace;',pUserDirBuffer}} によって参照されているバッファのサイズ ({{span style='color:blue;font-family:monospace;',TCHAR}} の数) を指定する {{span style='color:blue;font-family:monospace;',short}} 値へのポインタ。返り時に、この値は {{span style='color:blue;font-family:monospace;',pUserDirBuffer}} の実際のサイズになります。バッファが小さすぎたためにこの関数が失敗した場合、返り時の {{span style='color:blue;font-family:monospace;',psUserDirBufSize}} の値は必要とされるバッファ サイズになっています。 '''返り値''' 成功した場合、値 >= 0 を返します。この値は {{span style='color:blue;font-family:monospace;',pUserDirBuffer}} に保存されたユーザ ディレクトリ名の長さです。 成功しなかった場合、以下のエラー コードの 1 つを返します。バッファがディレクトリ名を保持するために十分な大きさがなかった場合、この関数は {{span style='color:blue;font-family:monospace;',psUserDirBufSize}} に必要とされるサイズをセットし、エラー {{span style='color:blue;font-family:monospace;',ERR_UM_BUFSIZE_TOO_SMALL}} を返します。 *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_BUFSIZE_TOO_SMALL}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' 完全なパスを取得するには、{{goto UmGetRootDirectory,UmGetRootDirectory()}} と {{goto UmGetUserDirectory,UmGetUserDirectory()}} の結果 - 例えば、{{span_begin style='color:blue;font-family:monospace;'}}root_directory = "C:\Documents and Settings\\My Documents\Palm OS Desktop"{{span_end}} と {{span_begin style='color:blue;font-family:monospace;'}}user_directory = "NUser"{{span_end}} - を連結します。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmSetUserDirectory,UmSetUserDirectory()}} !{{anchor UmGetUserID}}UmGetUserID 関数 {{goto top,^TOP^}} '''目的''' インデックスによってユーザ データ保存場所からユーザ ID を返します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmGetUserID ( short sIndex, DWORD *pdwUserID ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ sIndex}} **ユーザ データ保存場所の中に存在するユーザを指定する 0 ベースのインデックス。 *{{span style='color:blue;font-family:monospace;',← pdwUserID}} **ユーザ ID を受け取るための {{span style='color:blue;font-family:monospace;',DWORD}} へのポインタ。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',EE_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',EE_UM_INVALID_USER_INDEX}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',EE_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',EE_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',EE_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',EE_UM_UNABLE_TO_CREATE_NEW_FILE}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''互換性''' *ユーザ データ API バージョン: すべて。4.0 よりも前のバージョンは、成功した場合はユーザ ID を返し、ユーザ ID が見つからなかった場合は 0 を返し、エラーが発生した場合は負値を返しました。キャストされる前のユーザ ID の値は負になる可能性があったため、成功したばあの返り値も負値になる可能性がありました。ユーザ データ API のバージョン 4.0 では上記の「返り値」のようにこの問題が修正されました。 *Palm OS バージョン: すべて '''参照''' {{goto UmGetIDFromPath,UmGetIDFromPath()}}, {{goto UmGetIDFromName,UmGetIDFromName()}} !{{anchor UmGetUserName}}UmGetUserName 関数 {{goto top,^TOP^}} '''目的''' 与えられたユーザ ID からユーザ データ保存場所の中に存在するユーザ名を取得します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmGetUserName ( DWORD dwUserID, char *pUserNameBuffer, short *psUserNameBufSize ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',← pUserNameBuffer}} **文字バッファへのポインタ。返り時には、このバッファは指定されたユーザの名前を保持します。 *{{span style='color:blue;font-family:monospace;',←→ psUserNameBufSize}} **{{span style='color:blue;font-family:monospace;',pUserNameBuffer}} によって参照されるバッファのサイズ (バイト数) を指定する {{span style='color:blue;font-family:monospace;',short}} 値へのポインタ。返り時には、この値は {{span style='color:blue;font-family:monospace;',pUserNameBuffer}} の実際のサイズになります。バッファが小さすぎたためにこの関数が失敗した場合、返り時の {{span style='color:blue;font-family:monospace;',psUserNameBufSize}} の値はバッファに必要とされるサイズになります。 '''返り値''' 成功した場合、ユーザ名の長さである 0 より大きな値を返します。さらに、同じ長さの値が {{span style='color:blue;font-family:monospace;',pUserNameBuffer}} に保存されます。 失敗した場合、以下のエラー コード値の 1 つを返します。バッファがユーザ名を保持するのに十分な大きさを持っていない場合、この関数は {{span style='color:blue;font-family:monospace;',psUserNameBufSize}} に必要とされるサイズをセットし、エラー {{span style='color:blue;font-family:monospace;',ERR_UM_BUFSIZE_TOO_SMALL}} を返します。 *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_BUFSIZE_TOO_SMALL}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmSetUserName,UmSetUserName()}} !{{anchor UmGetUserPassword}}UmGetUserPassword 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザ ID から暗号化されたユーザ パスワードを取得します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmGetUserPassword ( DWORD dwUserID, TCHAR *pUserPasswordBuffer, short *psUserPasswordBufSize ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',← pUserPasswordBuffer}} **文字バッファへのポインタ。返り時には、このバッファは指定されたユーザの暗号化されたパスワードを保持します。 *{{span style='color:blue;font-family:monospace;',←→ psUserPasswordBufSize}} **{{span style='color:blue;font-family:monospace;',pUserPasswordBuffer}} によって参照されるバッファのサイズ ({{span style='color:blue;font-family:monospace;',TCHAR}} の数) を指定する {{span style='color:blue;font-family:monospace;',short}} 値へのポインタ。返り時には、この値は {{span style='color:blue;font-family:monospace;',pUserPasswordBuffer}} の実際のサイズになります。バッファが小さすぎたためにこの関数が失敗した場合、返り時の {{span style='color:blue;font-family:monospace;',psUserPasswordBufSize}} の値はバッファに必要とされるサイズになります。 '''返り値''' 成功した場合、パスワードの長さである 0 以上の値を返します。さらに、同じ長さの値が {{span style='color:blue;font-family:monospace;',pUserPasswordBuffer}} に保存されます。 失敗した場合、以下の非 0 のエラー コード値の 1 つである 0 より小さな値を返します。バッファがパスワードを保持するのに十分な大きさを持っていない場合、この関数は {{span style='color:blue;font-family:monospace;',psUserPasswordBufSize}} に必要とされるサイズをセットし、エラー {{span style='color:blue;font-family:monospace;',ERR_UM_BUFSIZE_TOO_SMALL}} を返します。 *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_BUFSIZE_TOO_SMALL}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''互換性''' *ユーザ データ API バージョン: すべて。更なる情報は {{goto "User Data API, Version 4.1 Changes",「ユーザ データ API バージョン 4.1 の変更点|C/C++ Sync Suite Reference601/A}} を参照してください。 *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}} !{{anchor UmGetUserPermSyncPreferences}}UmGetUserPermSyncPreferences 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザ ID からコンジットの永久同期設定を取得します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmGetUserPermSyncPreferences ( DWORD dwUserID, DWORD dwCreatorID, long *pUsaAction ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',→ dwCreatorID}} **アクセスするコンジットのクリエイタ ID。 *{{span style='color:blue;font-family:monospace;',← pUsaAction}} **{{goto UmSetSyncAction,UmSetSyncAction}} によって定義された同期設定を受け取るための {{span style='color:blue;font-family:monospace;',long}} へのポインタ。 '''返り値''' 成功した場合、{{goto UmUserSyncAction,UmUserSyncAction}} の 1 つを返します。さらにこれは {{span style='color:blue;font-family:monospace;',pUsaAction}} にも返されます。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',-1}} **特定されていないエラーが起こったか、指定されたクリエイタ ID に対してセットされた永久設定は存在しません。 *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SAVE_ERR}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmSetUserPermSyncPreferences,UmSetUserPermSyncPreferences()}}, {{goto UmDeleteUserPermSyncPreferences,UmDeleteUserPermSyncPreferences()}} !{{anchor UmGetUserTempSyncPreferences}}UmGetUserTempSyncPreferences 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザ ID からコンジットの一時同期設定を取得します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmGetUserTempSyncPreferences ( DWORD dwUserID, DWORD dwCreatorID, long *pUsaAction ) *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',→ dwCreatorID}} **アクセスするコンジットのクリエイタ ID。 *{{span style='color:blue;font-family:monospace;',← pUsaAction}} **{{goto UmSetSyncAction,UmSetSyncAction}} によって定義された同期設定を受け取るための {{span style='color:blue;font-family:monospace;',long}} へのポインタ。 '''返り値''' 成功した場合、{{goto UmUserSyncAction,UmUserSyncAction}} の 1 つを返します。さらにこれは {{span style='color:blue;font-family:monospace;',pUsaAction}} にも返されます。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',-1}} **特定されていないエラーが起こったか、指定されたクリエイタ ID に対してセットされた永久設定は存在しません。 *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SAVE_ERR}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmSetUserTempSyncPreferences,UmSetUserTempSyncPreferences()}}, {{goto UmRemoveUserTempSyncPreferences,UmRemoveUserTempSyncPreferences()}}, {{goto UmDeleteUserTempSyncPreferences,UmDeleteUserTempSyncPreferences()}} !{{anchor UmIsInstallMaskSet}}UmIsInstallMaskSet 関数 {{goto top,^TOP^}} '''目的''' 指定されたインストール コンジットが次の HotSync の最中に指定されたユーザのために実行されるようにセットされているかどうかを決定します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmIsInstallMaskSet ( DWORD dwUserID, DWORD dwMask ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',→ dwMask}} **あなたが実行ステータスを知ろうとしているインストール コンジットに関連付けされている 1 ビット マスク。 '''返り値''' 指定されたインストール コンジットが実行されるようセットされている場合、{{span style='color:blue;font-family:monospace;',true}} を返します。 指定されたインストール コンジットが実行されるようセットされていない場合、{{span style='color:blue;font-family:monospace;',false}} を返します。 失敗した場合、以下の非 0 のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' HotSync の最中に、HotSync マネージャはあなたが提供した {{span style='color:blue;font-family:monospace;',dwMask}} ビット マスク (これはあなたが実行ステータスを知ろうとしているインストール コンジットに対応するものです) と指定されたユーザの "Install" コンフィグレーション エントリの AND をとります。この関数はあなたが指定したビット マスクがセットされている場合 {{span style='color:blue;font-family:monospace;',true}} を返します; セットされていない場合 {{span style='color:blue;font-family:monospace;',false}} を返します。あなたが {{span style='color:blue;font-family:monospace;',dwMask}} 値を知らない場合、各インストール コンジットの {{span style='color:blue;font-family:monospace;',dwMask}} 値を取得するために {{goto PltGetInstallConduitInfo,PltGetInstallConduitInfo()|C/C++ Sync Suite Reference601/15}} を使用します。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmSetInstallMask,UmSetInstallMask()}}, {{goto UmClearInstallMask,UmClearInstallMask()}} !{{anchor UmIsUserInstalled}}UmIsUserInstalled 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザが「インストールされている」かどうかを決定します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmIsUserInstalled ( DWORD dwUserID ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 '''返り値''' ユーザがインストールされているユーザである場合、{{span style='color:blue;font-family:monospace;',true}} を返します。 ユーザがインストールされていないユーザである場合、{{span style='color:blue;font-family:monospace;',false}} を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' 「インストールされている」ユーザとは、少なくとも 1 度は HotSync を完了していて、そのためにデスクトップ コンピュータとハンドヘルドの両方にそのユーザ ID が存在しているユーザです。デスクトップ上で作成されたが HotSync を完了したことのないユーザは「インストールされた」ユーザではありません。それらのユーザはデスクトップ上でのそれらのユーザ ID と同じユーザ ID を持つハンドヘルドと同期を行ったときに「インストールされた」ユーザになります。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmSetUserInstall,UmSetUserInstall()}} !{{anchor UmIsUserNameValid}}UmIsUserNameValid 関数 {{goto top,^TOP^}} '''目的''' 提供された文字列が有効な HotSync ユーザ名であるかどうかを決定します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' bool UmIsUserNameValid ( const TCHAR *pUserName ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ pUserName}} **検証するユーザ名を保持している文字バッファへのポインタ。 '''返り値''' ユーザ名が有効である場合、{{span style='color:blue;font-family:monospace;',true}} を返します。 ユーザ名が無効である場合、{{span style='color:blue;font-family:monospace;',false}} を返します。 '''コメント''' この関数は提供されたユーザ名の以下の特性を検証します: *少なくとも 1 個から 20 個までの有効な文字を保持している ({{span style='color:blue;font-family:monospace;',pUserName}} が {{span style='color:blue;font-family:monospace;',NULL}} であったり、空の文字列バッファを指している場合、ユーザ名は無効になります)。 *以下の無効な文字を保持していない:{{br}}{{span style='color:blue;font-family:monospace;',"~!@#$%^&*()`+=[]{}:\";',<>?/|\\"}}{{br}}ユーザ名はピリオド (.), ハイフン (-), アンダスコア (_) 文字を保持するかもしれません。 *スペース文字ではない有効な文字を少なくとも 1 個は保持している。 *マルチ バイト スペース文字で始まらない。ユーザ名はシングル バイト スペース文字で始まるかもしれません; しかしながら、これはこの関数の将来のバージョンでは許可されなくなるかもしれません。 新しいユーザを作成するためにユーザ名を {{goto UmAddUser,UmAddUser()}} に渡す前にそのユーザ名を検証するためにこの関数を使用します。ユーザ名を検証すると、そのユーザ名が HotSync ログに現れるときに、そのログが誤ったフォーマットにならないようそのユーザ名が特別な HTML 文字を含まないことが保証されます。 '''互換性''' *ユーザ データ API バージョン: 4.2 よりも後のバージョン *Palm OS バージョン: すべて '''参照''' {{goto UmAddUser,UmAddUser()}} !{{anchor UmIsUserProfile}}UmIsUserProfile 関数 {{goto top,^TOP^}} '''目的''' アカウントがユーザ プロファイルであるかどうかを決定します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmIsUserProfile ( DWORD dwUserID ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 '''返り値''' アカウントがユーザ プロファイルである場合、{{span style='color:blue;font-family:monospace;',true}} を返します。 アカウントがユーザ プロファイルでない場合、{{span style='color:blue;font-family:monospace;',false}} を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' {{goto user profile,ユーザ プロファイル|Introduction to Conduit Development601/Glossary}} についての更なる情報は、''Introduction to Conduit Development'' の用語集を参照してください。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}} !{{anchor UmRemoveUserTempSyncPreferences}}UmRemoveUserTempSyncPreferences 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザ ID の指定されたコンジットの一時同期設定を削除します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmRemoveUserTempSyncPreferences ( DWORD dwUserID, DWORD dwCreatorID ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',→ dwCreatorID}} **アクセスするコンジットのクリエイタ ID。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SAVE_ERR}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' {{span style='color:blue;font-family:monospace;',UmRemoveUserTempSyncPreferences()}} は指定されたコンジットの一時同期設定をクリアし、それにより次の HotSync では永久同期セットにセットされているアクションがとられます。この関数の結果は、ユーザが HotSync マネージャの '''Custom''' > '''Change''' オプションをクリックしたことがなくコンジットの一時同期設定を変更したことがない場合と同じです。 ::NOTE :::個の関数はただ 1 つだけのコンジットの一時同期設定をクリアします。この関数とは対照的に、{{goto UmDeleteUserTempSyncPreferences,UmDeleteUserTempSyncPreferences()}} はユーザのすべてのコンジットの一時同期設定をクリアします。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmSetUserTempSyncPreferences,UmSetUserTempSyncPreferences()}}, {{goto UmGetUserTempSyncPreferences,UmGetUserTempSyncPreferences()}}, {{goto UmDeleteUserTempSyncPreferences,UmDeleteUserTempSyncPreferences()}} !{{anchor UmSetInstallMask}}UmSetInstallMask 関数 {{goto top,^TOP^}} '''目的''' 指定されたインストール コンジットを次の HotSync の最中に指定されたユーザのために実行するよう選択します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmSetInstallMask ( DWORD dwUserID, DWORD dwMask ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',→ dwMask}} **あなたが実行させようとしているインストール コンジットに関連付けされている 1 ビット マスク。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' HotSync の最中に、HotSync マネージャはあなたが提供した {{span style='color:blue;font-family:monospace;',dwMask}} ビット マスク (これはあなたが実行させようとするインストール コンジットに対応するものです) と指定されたユーザの "Install" コンフィグレーション エントリの OR をとります。結果の値は指定されたユーザの "Install" コンフィグレーション エントリに保存されます。この関数の結果として、"Install" エントリの中にあるビットがセットされ、それにより次の HotSync の最中に対応するインストール コンジットが指定されたユーザのために実行されます。"Install" エントリの中にある他のビットの状態は変更されません。あなたが {{span style='color:blue;font-family:monospace;',dwMask}} 値を知らない場合、各インストール コンジットの {{span style='color:blue;font-family:monospace;',dwMask}} 値を取得するために {{goto PltGetInstallConduitInfo,PltGetInstallConduitInfo()|C/C++ Sync Suite Reference601/15}} を使用します。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmIsInstallMaskSet,UmIsInstallMaskSet()}}, {{goto UmClearInstallMask,UmClearInstallMask()}} !{{anchor UmSetInteger}}UmSetInteger 関数 {{goto top,^TOP^}} '''目的''' ユーザ データ保存場所の指定されたユーザのエリアの中にあるキーに整数値をセットします。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmSetInteger ( DWORD dwUserID, const TCHAR *pszSection, const TCHAR *pszKey, long lValue ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',→ pszSection}} **ユーザ データ保存場所の指定されたユーザのエリアの中にあるセクション名。 *{{span style='color:blue;font-family:monospace;',→ pszKey}} **セットする整数のキー。 *{{span style='color:blue;font-family:monospace;',→ lValue}} **ユーザ データ保存場所の指定されたユーザのキーに書き込む整数。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_BUFSIZE_TOO_SMALL}} *{{span style='color:blue;font-family:monospace;',ERR_UM_CANNOT_WRITE_TO_STORE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' 提供されたセクションの名前とキーからユーザ データ保存場所の中にある整数キーの値をセットするためにこの関数を使用します。あなたはこの関数を使用してあなた自身のキーをクリアまたはセットすることができます。しかしながら、値をセットするためのユーザ データ API 関数が存在する場合、この汎用関数ではなくその専用関数を使用してください。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmGetInteger,UmGetInteger()}} !{{anchor UmSetString}}UmSetString 関数 {{goto top,^TOP^}} '''目的''' ユーザ データ保存場所の指定されたユーザのエリアの中にあるキーに文字列値をセットします。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmSetString ( DWORD dwUserID, const TCHAR *pszSection, const TCHAR *pszKey, const TCHAR *pszValue ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',→ pszSection}} **ユーザ データ保存場所の指定されたユーザのエリアの中にあるセクション名。 *{{span style='color:blue;font-family:monospace;',→ pszKey}} **セットする文字列のキー。 *{{span style='color:blue;font-family:monospace;',→ pszValue}} **ユーザ データ保存場所の指定されたユーザのキーに書き込む文字列。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_BUFSIZE_TOO_SMALL}} *{{span style='color:blue;font-family:monospace;',ERR_UM_CANNOT_WRITE_TO_STORE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' 提供されたセクションの名前とキーからユーザ データ保存場所の中にある文字列キーの値をセットするためにこの関数を使用します。あなたはこの関数を使用してあなた自身のキーをクリアまたはセットすることができます。しかしながら、値をセットするためのユーザ データ API 関数が存在する場合、この汎用関数ではなくその専用関数を使用してください。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmGetString,UmGetString()}} !{{anchor UmSetUserDirectory}}UmSetUserDirectory 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザ ID のディレクトリ名をセットします。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmSetUserDirectory ( DWORD dwUserID, const TCHAR *pUserDir ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',→ pUserDir}} **セットするユーザ ディレクトリの名前を保持している文字バッファ。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER_DIR}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SAVE_ERR}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_DIR_ALREADY_IN_USE}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmGetUserDirectory,UmGetUserDirectory()}} !{{anchor UmSetUserInstall}}UmSetUserInstall 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザ ID の "installed" (「インストールされた」) フラグをセットまたはクリアします。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmSetUserInstall ( DWORD dwUserID, BOOL bUserInstall ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',→ bUserInstall}} **ブール値。これが {{span style='color:blue;font-family:monospace;',true}} である場合、ユーザは「インストールされた」ユーザとしてセットされます; これが {{span style='color:blue;font-family:monospace;',false}} である場合、ユーザは「インストールされた」ユーザではないとセットされます。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SAVE_ERR}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' 「インストールされている」ユーザとは、少なくとも 1 度は HotSync を完了していて、そのためにデスクトップ コンピュータとハンドヘルドの両方にそのユーザ ID が存在しているユーザです。デスクトップ上で作成されたが HotSync を完了したことのないユーザは「インストールされた」ユーザではありません。それらのユーザはデスクトップ上でのそれらのユーザ ID と同じユーザ ID を持つハンドヘルドと同期を行ったときに「インストールされた」ユーザになります。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmIsUserInstalled,UmIsUserInstalled()}} !{{anchor UmSetUserName}}UmSetUserName 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザ ID のユーザ名をセットします。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmSetUserName ( DWORD dwUserID, const char *pUserName ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',→ pUserName}} **セットするユーザ名を保持している文字バッファ。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SAVE_ERR}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ALREADY_EXISTS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmGetUserName,UmGetUserName()}} !{{anchor UmSetUserPermSyncPreferences}}UmSetUserPermSyncPreferences 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザ ID のコンジットの永久同期設定をセットします。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmSetUserPermSyncPreferences ( DWORD dwUserID, DWORD dwCreatorID, long usaAction ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',→ dwCreatorID}} **アクセスするコンジットのクリエイタ ID。 *{{span style='color:blue;font-family:monospace;',→ usaAction}} **実行する同期アクション。{{goto UmUserSyncAction,UmUserSyncAction}} 列挙値の 1 つを指定します。 '''返り値''' 成功した場合、{{span style='color:blue;font-family:monospace;',true}} を返します。 設定をセットすることができなかった場合、{{span style='color:blue;font-family:monospace;',false}} を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SAVE_ERR}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmGetUserPermSyncPreferences,UmGetUserPermSyncPreferences()}}, {{goto UmDeleteUserPermSyncPreferences,UmDeleteUserPermSyncPreferences()}} !{{anchor UmSetUserTempSyncPreferences}}UmSetUserTempSyncPreferences 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザ ID のコンジットの一時同期設定をセットします。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmSetUserTempSyncPreferences ( DWORD dwUserID, DWORD dwCreatorID, long usaAction ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。これはユーザ データ保存場所を参照するユーザを指定します。 *{{span style='color:blue;font-family:monospace;',→ dwCreatorID}} **アクセスするコンジットのクリエイタ ID。 *{{span style='color:blue;font-family:monospace;',→ usaAction}} **実行する同期アクション。{{goto UmUserSyncAction,UmUserSyncAction}} 列挙値の 1 つを指定します。 '''返り値''' 成功した場合、{{span style='color:blue;font-family:monospace;',true}} を返します。 設定をセットすることができなかった場合、{{span style='color:blue;font-family:monospace;',false}} を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}} *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SAVE_ERR}} *{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}} *{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''互換性''' *ユーザ データ API バージョン: すべて *Palm OS バージョン: すべて '''参照''' {{goto UmGetUserID,UmGetUserID()}}, {{goto UmGetUserTempSyncPreferences,UmGetUserTempSyncPreferences()}}, {{goto UmRemoveUserTempSyncPreferences,UmRemoveUserTempSyncPreferences()}}, {{goto UmDeleteUserTempSyncPreferences,UmDeleteUserTempSyncPreferences()}} !{{anchor UmSlotGetDisplayName}}UmSlotGetDisplayName 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザのハンドヘルド上にある指定されたスロットの表示名を取得します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmSlotGetDisplayName ( DWORD dwUserId, DWORD dwSlotId, TCHAR *pszSlotDisplayName, long *plSize ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。 *{{span style='color:blue;font-family:monospace;',→ dwSlotId}} **名前を取得するスロットの ID。スロット ID を取得するには、ユーザ データ API の {{goto UmSlotGetInfo,UmSlotGetInfo()}} 関数を使用します。 *{{span style='color:blue;font-family:monospace;',← pszSlotDisplayName}} **指定されたスロットの表示名を保持する文字バッファへのポインタ。この関数を呼び出す前にこのバッファに割り当てを行わなければなりません。 *{{span style='color:blue;font-family:monospace;',←→ plSize}} **{{span style='color:blue;font-family:monospace;',pszSlotDisplayName}} バッファのサイズを示す {{span style='color:blue;font-family:monospace;',long}} へのポインタ。呼び出し時には、これはバッファに割り当てられたサイズを指します。返り時には、渡されたサイズが小さすぎた場合はあなたがバッファに割り当てなければならないバイト数を指します。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_BUFSIZE_TOO_SMALL}} *{{span style='color:blue;font-family:monospace;',ERR_UM_DEV_CFG_DATA_NOT_AVAILABLE}} {{span style='color:blue;font-family:monospace;',pszSlotDisplayName}} が表示名を保持するには小さすぎる場合、この関数は {{span style='color:blue;font-family:monospace;',ERR_UM_BUFSIZE_TOO_SMALL}} を返し、必要とされるサイズを {{span style='color:blue;font-family:monospace;',plSize}} に返します。 すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' ユーザの利便性のためにスロットを特定するのにスロット ID ではなく、表示名を使用してください。 HotSync マネージャは各 HotSync の開始時にスロットにそのスロットのメディア タイプに基づく名前を割り当て、それをデスクトップ上のユーザ情報保存場所の中の対応するユーザのために保存します。この関数は単純に保存されている情報を返すだけです。そのため、ユーザはハンドヘルドを変更したり更新するかもしれないので、次の HotSync では正しい情報ではなくなるかもしれません。 あなたはこの関数や他のスロット関連のユーザ データ関数を呼び出す前に、ハンドヘルド上の拡張マネージャの存在 (とそのバージョン) をチェックするために {{goto UmSlotGetExpMgrVersion,UmSlotGetExpMgrVersion()}} を呼び出さなければなりません。 '''例''' TCHAR szDisplayName [256]; long lSize = sizeof (szDisplayName); long retval = UmSlotGetDisplayName (dwUserId, dwSlotId, szDisplayName, &lSize); '''互換性''' *ユーザ データ API バージョン: 4.0 以降 *Palm OS バージョン: 4.0 以降 '''参照''' {{goto UmSlotGetInfo,UmSlotGetInfo()}} !{{anchor UmSlotGetExpMgrVersion}}UmSlotGetExpMgrVersion 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザのハンドヘルドの拡張マネージャのバージョンを取得します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmSlotGetExpMgrVersion ( DWORD dwUserId, DWORD *pdwExpMgrVersion ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。 *{{span style='color:blue;font-family:monospace;',← pdwExpMgrVersion}} **ハンドヘルド上の拡張マネージャのバージョンを保持する {{span style='color:blue;font-family:monospace;',DWORD}} へのポインタ。拡張マネージャが存在しない場合、この値は 0 になります - この場合、他のスロット関連の関数を呼び出してはいけません。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_DEV_CFG_DATA_NOT_AVAILABLE}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' HotSync マネージャは各 HotSync の開始時にスロットにそのスロットのメディア タイプに基づく名前を割り当て、それをデスクトップ上のユーザ情報保存場所の中の対応するユーザのために保存します。この関数は単純に保存されている情報を返すだけです。そのため、ユーザはハンドヘルドを変更したり更新するかもしれないので、次の HotSync では正しい情報ではなくなるかもしれません。 あなたは他のスロット関連のユーザ データ関数を呼び出す前に、ハンドヘルド上の拡張マネージャの存在 (とそのバージョン) をチェックするために {{span style='color:blue;font-family:monospace;',UmSlotGetExpMgrVersion()}} を呼び出さなければなりません。 '''例''' DWORD dwExpMgrVersion; long retval = UmSlotGetExpMgrVersion (dwUserId, &dwExpMgrVersion); '''互換性''' *ユーザ データ API バージョン: 4.0 以降 *Palm OS バージョン: 4.0 以降 !{{anchor UmSlotGetInfo}}UmSlotGetInfo 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザのハンドヘルド上に存在する各拡張スロットのスロット ID を取得します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmSlotGetInfo ( DWORD dwUserId, DWORD *pdwSlotIdList, WORD *pwNumEntries ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。 *{{span style='color:blue;font-family:monospace;',← pdwSlotIdList}} **各スロットの ID を保持する {{span style='color:blue;font-family:monospace;',DWORD}} 配列へのポインタ。 *{{span style='color:blue;font-family:monospace;',←→ pwNumEntries}} **{{span style='color:blue;font-family:monospace;',pdwSlotIdList}} 配列の中のエントリの数を示す {{span style='color:blue;font-family:monospace;',DWORD}} へのポインタ。呼び出し時には、{{span style='color:blue;font-family:monospace;',pdwSlotIdList}} 配列に割り当てられたエントリの数を指します。呼び出し元はまずスロット数を取得するために {{goto UmSlotGetSlotCount,UmSlotGetSlotCount()}} を呼び出し、その数のエントリを割り当てるべきです。返り時には、ID No取得に成功したスロットの数を指します - これは実際に存在するスロットの数とは等しくないかもしれません。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_DEV_CFG_DATA_NOT_AVAILABLE}} *{{span style='color:blue;font-family:monospace;',ERR_UM_BUFSIZE_TOO_SMALL}} {{span style='color:blue;font-family:monospace;',pdwSlotIdList}} 配列が小さすぎる場合、この関数は {{span style='color:blue;font-family:monospace;',ERR_UM_BUFSIZE_TOO_SMALL}} を返し、{{span style='color:blue;font-family:monospace;',pwNumEntries}} に必要とされるサイズをセットします。 すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' ハンドヘルド上の拡張マネージャはスロット参照番号によってスロットを識別します。これらのスロット参照番号はスロット ドライバが拡張マネージャによってロードされる順番によって変わるかもしれません。その上、スロット参照番号は HotSync の最中にコンジットのみが使用可能です。そのため、ユーザ データ API はスロットを識別するためにスロット参照番号の代わりにスロット ID を使用します。 HotSync マネージャは各 HotSync の開始時にハンドヘルド上のスロットにスロット ID を割り当て、それらをデスクトップ上のユーザ情報保存場所の中の対応するユーザのために保存します。この関数は単純に保存されている情報を返すだけです。そのため、ユーザはハンドヘルドを変更したり更新するかもしれないので、次の HotSync では正しい情報ではなくなるかもしれません。 あなたはこの関数や他のスロット関連のユーザ データ関数を呼び出す前に、ハンドヘルド上の拡張マネージャの存在 (とそのバージョン) をチェックするために {{goto UmSlotGetExpMgrVersion,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 以降 '''参照''' {{goto UmSlotGetSlotCount,UmSlotGetSlotCount()}}, {{goto UmSlotGetExpMgrVersion,UmSlotGetExpMgrVersion()}} !{{anchor UmSlotGetInstallDirectory}}UmSlotGetInstallDirectory 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザとハンドヘルド スロットからスロット インストール ディレクトリ名 (フル パスではありません) を取得します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmSlotGetInstallDirectory ( DWORD dwUserId, DWORD dwSlotId, TCHAR *pszSlotInstallDir, long *plSize ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。 *{{span style='color:blue;font-family:monospace;',→ dwSlotId}} **スロット インストール ディレクトリを取得するスロットの ID。スロット ID を取得するにはユーザ データ API の {{goto UmSlotGetInfo,UmSlotGetInfo()}} 関数を使用します。 *{{span style='color:blue;font-family:monospace;',← pszSlotInstallDir}} **指定されたスロットのスロット インストール ディレクトリの名前を保持する文字バッファへのポインタ。この関数を呼び出す前にこのバッファに割り当てを行わなければなりません。 *{{span style='color:blue;font-family:monospace;',←→ plSize}} **{{span style='color:blue;font-family:monospace;',pszSlotInstallDir}} バッファのサイズを示す {{span style='color:blue;font-family:monospace;',long}} へのポインタ。呼び出し時には、バッファに割り当てられたサイズを指します。返り時には、渡されたサイズが小さすぎた場合はあなたがバッファに割り当てなければならないバイト数を指します。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_BUFSIZE_TOO_SMALL}} *{{span style='color:blue;font-family:monospace;',ERR_UM_DEV_CFG_DATA_NOT_AVAILABLE}} {{span style='color:blue;font-family:monospace;',pszSlotInstallDir}} がディレクトリ名を保持するには小さすぎる場合、この関数は {{span style='color:blue;font-family:monospace;',ERR_UM_BUFSIZE_TOO_SMALL}} を返し、{{span style='color:blue;font-family:monospace;',plSize}} に必要とされるサイズを返します。 すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' スロット インストール ディレクトリは、インストール援助機能が指定されたユーザのハンドヘルド上の対応するスロットにインストールするためにキューに追加されるファイルを置くデスクトップ上の場所です。 HotSync マネージャは各 HotSync の開始時にこの情報をデスクトップ上のユーザ情報保存場所の中の対応するユーザのために保存します。この関数は単純に保存されている情報を返すだけです。そのため、ユーザはハンドヘルドを変更したり更新するかもしれないので、次の HotSync では正しい情報ではなくなるかもしれません。ファイルがスロットにインストールされるためにキューに追加されていて、そのスロット情報が次の HotSync の最中に変更された場合、インストール コンジットはそのファイルを無視するかもしれませんが、スロット インストール ディレクトリ自体を削除することはしません。 あなたはこの関数や他のスロット関連のユーザ データ関数を呼び出す前に、ハンドヘルド上の拡張マネージャの存在 (とそのバージョン) をチェックするために {{goto UmSlotGetExpMgrVersion,UmSlotGetExpMgrVersion()}} を呼び出さなければなりません。 '''例''' TCHAR szInstallDir [256]; long lSize = sizeof (szInstallDir); long retval = UmSlotGetInstallDirectory (dwUserId, dwSlotId, szInstallDir, &lSize); '''互換性''' *ユーザ データ API バージョン: 4.0 以降 *Palm OS バージョン: 4.0 以降 '''参照''' {{goto UmSlotGetInfo,UmSlotGetInfo()}}, {{goto UmSlotGetExpMgrVersion,UmSlotGetExpMgrVersion()}}, ''C/C++ Sync Suite Companion '' の {{goto Install Directory Terminology,「インストール ディレクトリ用語」|C/C++ Sync Suite Companion601/9-1}} !{{anchor UmSlotGetMediaType}}UmSlotGetMediaType 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザのハンドヘルドの指定されたスロットのメディア タイプを取得します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmSlotGetMediaType ( DWORD dwUserId, DWORD dwSlotId, DWORD *pdwSlotMediaType ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。 *{{span style='color:blue;font-family:monospace;',→ dwSlotId}} **メディア タイプを取得するスロットの ID。スロット ID を取得するには、ユーザ データ API の {{goto UmSlotGetInfo,UmSlotGetInfo()}} 関数を使用します。 *{{span style='color:blue;font-family:monospace;',← pdwSlotMediaType}} **指定されたスロットのメディア タイプを保持する {{span style='color:blue;font-family:monospace;',DWORD}} へのポインタ。スロット メディア タイプは {{goto Media Type Constants,「メディア タイプ定数」|C/C++ Sync Suite Reference601/9}} で定義されています。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_DEV_CFG_DATA_NOT_AVAILABLE}} すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' HotSync マネージャは各 HotSync の開始時にこの情報を取得し、それをデスクトップ上のユーザ情報保存場所の中の対応するユーザのために保存します。この関数は単純に保存されている情報を返すだけです。そのため、ユーザはハンドヘルドを変更したり更新するかもしれないので、次の HotSync では正しい情報ではなくなるかもしれません。 あなたはこの関数や他のスロット関連のユーザ データ関数を呼び出す前に、ハンドヘルド上の拡張マネージャの存在 (とそのバージョン) をチェックするために {{goto UmSlotGetExpMgrVersion,UmSlotGetExpMgrVersion()}} を呼び出さなければなりません。 '''例''' DWORD dwSlotMediaType; long retval = UmSlotGetMediaType (dwUserId, dwSlotId, &dwSlotMediaType); '''互換性''' *ユーザ データ API バージョン: 4.0 以降 *Palm OS バージョン: 4.0 以降 '''参照''' {{goto UmSlotGetInfo,UmSlotGetInfo()}}, {{goto UmSlotGetExpMgrVersion,UmSlotGetExpMgrVersion()}} !{{anchor UmSlotGetSlotCount}}UmSlotGetSlotCount 関数 {{goto top,^TOP^}} '''目的''' 指定されたユーザのハンドヘルド上にある拡張スロットの数を取得します。 '''宣言されている場所''' {{span style='color:blue;font-family:monospace;',UserData.h}} '''Prototype''' long UmSlotGetSlotCount ( DWORD dwUserId, WORD *pwNumSlots ) '''パラメータ''' *{{span style='color:blue;font-family:monospace;',→ dwUserID}} **ユーザ ID。 *{{span style='color:blue;font-family:monospace;',← pwNumSlots}} **ハンドヘルド上のスロットの数を保持する {{span style='color:blue;font-family:monospace;',DWORD}} へのポインタ。ハンドヘルドが拡張スロットを持たない場合、このポインタが指す値は 0 になります。 '''返り値''' 成功した場合、0 を返します。 失敗した場合、以下のエラー コード値の 1 つを返します: *{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_POINTER}} *{{span style='color:blue;font-family:monospace;',ERR_UM_DEV_CFG_DATA_NOT_AVAILABLE}} ハンドヘルドがスロットを持たない場合、この関数は {{span style='color:blue;font-family:monospace;',ERR_UM_DEV_CFG_DATA_NOT_AVAILABLE}} を返し、{{span style='color:blue;font-family:monospace;',*pwNumSlot}} に 0 を返します。 すべてのユーザ データ API エラー コードについての説明は、{{goto User Data API Error Codes,「ユーザ データ API エラー コード」}} を参照してください。 '''コメント''' HotSync マネージャは各 HotSync の開始時にこの情報を取得し、それをデスクトップ上のユーザ情報保存場所の中の対応するユーザのために保存します。この関数は単純に保存されている情報を返すだけです。そのため、ユーザはハンドヘルドを変更したり更新するかもしれないので、次の HotSync では正しい情報ではなくなるかもしれません。 あなたはこの関数や他のスロット関連のユーザ データ関数を呼び出す前に、ハンドヘルド上の拡張マネージャの存在 (とそのバージョン) をチェックするために {{goto UmSlotGetExpMgrVersion,UmSlotGetExpMgrVersion()}} を呼び出さなければなりません。 '''例''' WORD wNumSlots; long retval = UmSlotGetSlotCount (dwUserId, &wNumSlots); '''互換性''' *ユーザ データ API バージョン: 4.0 以降 *Palm OS バージョン: 4.0 以降 '''参照''' {{goto UmSlotGetExpMgrVersion,UmSlotGetExpMgrVersion()}} !!{{anchor User Data API Error Codes}}ユーザ データ API エラー コード {{goto top,^TOP^}} {{goto Table 16.1,表 16.1}} はユーザ データ API 関数が返す可能性のあるエラー コードの値をリスト アップしています。各関数の説明でその関数が返す可能性のあるエラーについて述べています。 以下の名前を付けられているエラー コードはすべてプロセッサ定数として定義されていて、{{span style='color:blue;font-family:monospace;',UserData.h}} ヘッダ ファイルの中で宣言されています。 {{anchor Table 16.1}} '''表 16.1 ユーザ データ API エラー コード''' ,値,エラー コード,説明 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFFFF}}",―,特定されていないエラーが起こりました。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFDED}}","{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DEFAULT_USER}}",デフォルト HotSync ユーザがセットされていないか、無効なユーザ ID がセットされています。このエラー コードは将来使用するために予約されています。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFDEE}}","{{span style='color:blue;font-family:monospace;',ERR_UM_MULTIPLE_USERS_EXISTS}}",ユーザ データ保存場所の中に複数のユーザが存在します。このエラー コードは将来使用するために予約されています。 ,"{{anchor ERR_UM_DEV_CFG_DATA_NOT_AVAILABLE}}{{span style='color:blue;font-family:monospace;',0xFFFFFDEF}}","{{span style='color:blue;font-family:monospace;',ERR_UM_DEV_CFG_DATA_NOT_AVAILABLE}}",ハンドヘルドについてのリクエストされた情報は利用不可です - 例えば、指定されたユーザに対して以前に保存された拡張スロット情報がないためです。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFDF0}}","{{span style='color:blue;font-family:monospace;',ERR_UM_FUNCTION_NOT_SUPPORTED}}",この関数はもはやサポートされません。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFDF1}}","{{span style='color:blue;font-family:monospace;',ERR_UM_STRING_TOO_BIG}}",取得しようとしている文字列は保存するには長すぎます。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFDF2}}","{{span style='color:blue;font-family:monospace;',ERR_UM_SYNC_PATH_TOO_BIG}}",このエラー コードを返す関数はありません。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFDF3}}","{{span style='color:blue;font-family:monospace;',ERR_UM_CANNOT_WRITE_TO_STORE}}",指定されたユーザのユーザ データ保存場所の中のエリアへの書き込みは失敗しました。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFDF4}}","{{span style='color:blue;font-family:monospace;',ERR_UM_USER_DIR_ALREADY_IN_USE}}",指定されたユーザ ディレクトリ名はすでに他のユーザによって使用されています。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFDF5}}","{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ALREADY_EXISTS}}",指定されたユーザはすでに存在します。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFDF6}}","{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_POINTER}}",指定されたポインタは無効です。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFDF7}}","{{span style='color:blue;font-family:monospace;',ERR_UM_NO_CORE_PATH}}","{{span style='color:blue;font-family:monospace;',Core\Path}} コンフィグレーション エントリの値は存在しません。{{goto UmGetRootDirectory,UmGetRootDirectory()}} を参照してください。" ,"{{span style='color:blue;font-family:monospace;',0xFFFFFDF8}}","{{span style='color:blue;font-family:monospace;',ERR_UM_UNABLE_TO_CREATE_NEW_FILE}}",新しいファイルの作成は失敗しました。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFDF9}}","{{span style='color:blue;font-family:monospace;',ERR_UM_SEMAPHORE_ACCESS}}",指定されたユーザ インデックスは無効です。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFDFA}}","{{span style='color:blue;font-family:monospace;',ERR_UM_OTHER_USERSDAT_ACCESS_PROBLEM}}",ユーザ データ保存場所にアクセスしようとしたときに未知のエラーが起こりました。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFDFB}}","{{span style='color:blue;font-family:monospace;',ERR_UM_BASE}}",このエラー コードを返す関数はありません。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFDFC}}","{{span style='color:blue;font-family:monospace;',ERR_UM_SAVE_ERR}}",変更の保存は成功せずに完了しました。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFDFD}}","{{span style='color:blue;font-family:monospace;',ERR_UM_USER_ACCESS}}",このユーザ データ関数はこのユーザ データにアクセスすることができません。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFDFE}}","{{span style='color:blue;font-family:monospace;',ERR_UM_BAD_FILENAME}}",ユーザ データ関数に渡されたファイルは有効なファイル タイプではありません。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFDFF}}","{{span style='color:blue;font-family:monospace;',ERR_UM_NOT_FOUND}}",このユーザ名パラメータはユーザ データ保存場所に含まれていません。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFE00}}","{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USER_FOUND}}",このユーザはユーザ データ保存場所の中に存在しません。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFE01}}","{{span style='color:blue;font-family:monospace;',ERR_UM_NO_DIRECTORY}}",このユーザ ディレクトリは存在しません。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFE02}}","{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER_DIR}}",指定されたユーザ ディレクトリは存在しません。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFE03}}","{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER_NAME}}",指定されたユーザ名は無効です。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFE04}}","{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_BUFFER}}",このエラー コードを返す関数はありません。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFE05}}","{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_INDEX}}",このエラー コードを返す関数はありません。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFE06}}","{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_REGISTRY}}",ユーザ データ関数は無効なコンフィグレーション エントリを書き込もうとしました。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFE07}}","{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER}}","提供されたユーザ ID は{{span style='color:blue;font-family:monospace;',NULL}} であるか、利用可能なユーザのためのものではありません。" ,"{{span style='color:blue;font-family:monospace;',0xFFFFFE08}}","{{span style='color:blue;font-family:monospace;',ERR_UM_BUFSIZE_TOO_SMALL}}",提供されたバッファはリクエストされた情報を保持するには小さすぎます。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFE09}}","{{span style='color:blue;font-family:monospace;',ERR_UM_INVALID_USER_INDEX}}",渡されたユーザ インデックスは範囲外です。インデックスは 0 以上で、ユーザ データ保存場所の中にあるユーザの数よりも小さくなるべきです。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFE0A}}","{{span style='color:blue;font-family:monospace;',ERR_UM_USERSDAT_ALREADY_EXISTS}}",このエラー コードを返す関数はありません。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFE0B}}","{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERS}}",ユーザ データ保存場所は存在しますが、情報を保持していません。 ,"{{span style='color:blue;font-family:monospace;',0xFFFFFE0C}}","{{span style='color:blue;font-family:monospace;',ERR_UM_NO_USERSDAT_FILE}}","ユーザ データ保存場所が見つかりません。このケースではたいていの関数は失敗します。新しい保存場所を作成するには {{goto UmAddUser,UmAddUser()}} を呼び出します。" {{div_end}} {{div_begin "style='border-top-style:solid;border-top-width:1px;border-top-color:silver;'"}} [[←　15 章に戻る|C/C++ Sync Suite Reference601/15]]　[[↑トップへ|C/C++ Sync Suite Reference601]]　[[17 章に進む　→|C/C++ Sync Suite Reference601/17]] {{div_end}}