Palm Programmer's Laboratory
C/C++ Sync Suite Reference601/11-1
- (ページ 1)
- コンジット マネージャ構造体
- コンジット マネージャ定数
- コンジット マネージャ関数
- CmConvertCreatorIDToString
- CmConvertStringToCreatorID
- CmGetBackupConduit
- CmGetComPort
- CmGetConduitByCreator
- CmGetConduitByIndex
- CmGetConduitCount
- CmGetConduitCreatorID
- CmGetCorePath
- CmGetCreatorArgument
- CmGetCreatorDirectory
- CmGetCreatorFile
- CmGetCreatorIDList
- CmGetCreatorInfo
- CmGetCreatorIntegrate
- CmGetCreatorModule
- CmGetCreatorName
- CmGetCreatorPriority
- CmGetCreatorRemote
- CmGetCreatorTitle
- CmGetCreatorType
- CmGetCreatorUser
- CmGetCreatorValueDword
- CmGetCreatorValueString
- (ページ 2)
- CmGetDiscoveryInfoByIndex
- CmGetHotSyncExecPath
- CmGetLibVersion
- CmGetNotifierDll
- CmGetPCIdentifier
- CmGetSystemBackupConduit
- CmGetSystemConduitByCreator
- CmGetSystemConduitByIndex
- CmGetSystemConduitCount
- CmGetSystemConduitCreatorID
- CmGetSystemCreatorDirectory
- CmGetSystemCreatorFile
- CmGetSystemCreatorIDList
- CmGetSystemCreatorName
- CmGetSystemCreatorPriority
- CmGetSystemCreatorRemote
- CmGetSystemCreatorTitle
- CmGetSystemCreatorValueDword
- CmGetSystemCreatorValueString
- CmGetSystemDiscoveryInfoByIndex
- CmGetSystemHotSyncExecPath
- CmInstallConduit
- CmInstallConduitByStruct
- CmInstallCreator
- CmInstallSystemConduitByStruct
- CmInstallSystemCreator
- CmIsCurrentUserAdmin
- CmRemoveConduitByCreatorID
- CmRemoveConduitByIndex
- CmRemoveSystemConduitByCreatorID
- CmRemoveSystemConduitByIndex
- CmRestoreHotSyncSettings
- (ページ 3)
- CmSetBackupConduit
- CmSetComPort
- CmSetCorePath
- CmSetCreatorArgument
- CmSetCreatorDirectory
- CmSetCreatorFile
- CmSetCreatorInfo
- CmSetCreatorIntegrate
- CmSetCreatorModule
- CmSetCreatorName
- CmSetCreatorPriority
- CmSetCreatorRemote
- CmSetCreatorTitle
- CmSetCreatorUser
- CmSetCreatorValueDword
- CmSetCreatorValueString
- CmSetHotSyncExecPath
- CmSetNotifierDll
- CmSetPCIdentifier
- CmSetSystemBackupConduit
- CmSetSystemCreatorDirectory
- CmSetSystemCreatorFile
- CmSetSystemCreatorName
- CmSetSystemCreatorPriority
- CmSetSystemCreatorRemote
- CmSetSystemCreatorTitle
- CmSetSystemCreatorValueDword
- CmSetSystemCreatorValueString
- FmDisableCurrentUserConduitByIndex
- FmDisableCurrentUserConduitByPath
- FmDisableSystemConduitByIndex
- FmDisableSystemConduitByPath
- FmEnableCurrentUserConduitByPath
- FmEnableSystemConduitByPath
- FmGetCurrentUserConduitByIndex
- FmGetCurrentUserConduitCount
- FmGetCurrentUserConduitFolder
- FmGetCurrentUserDisabledConduitFolder
- FmGetSystemConduitByIndex
- FmGetSystemConduitCount
- FmGetSystemConduitFolder
- FmGetSystemDisabledConduitFolder
- コンジット マネージャ エラー コード
コンジット マネージャ構造体 ^TOP^
CmConduitType 構造体 ^TOP^
目的
あなたがコンジットを登録するために CmInstallConduit() に渡すコンジット登録情報を指定します。
宣言されている場所
CondMgr.h
Prototype
typedef struct { int iStructureVersion; int iStructureSize; int iType; char szCreatorID[CM_CREATOR_ID_SIZE]; DWORD dwPriority; int iConduitNameOffset; int iDirectoryOffset; int iFileOffset; int iRemoteDBOffset; int iUsernameOffset; int iTitleOffset; int iInfoOffset; } CmConduitType
フィールド
- iStructureVersion
- 呼び出し元が使用しているこのデータ構造体のバージョン - これは 「その他の定数」 の中の定数 CONDUIT_VERSION として定義されています - を指定します。コンジット マネージャはこの値を使って構造体の中の情報をどのように処理するかを決定します。
- iStructureSize
- 構造体のサイズをバイト数で指定します。
- iType
- 「コンジット情報タイプ」 で説明されているコンジット情報タイプを指定します。
- szCreatorID[CM_CREATOR_ID_SIZE]
- Creator でセットされているコンジットの作成者 ID を指定します。
- dwPriority
- コンジットの Priority を指定します。
- iConduitNameOffset
- この構造体の開始点から Conduit にセットされているコンジット名文字列の最初の文字までのオフセットを指定します。
- iDirectoryOffset
- この構造体の開始点から Directory にセットされているディレクトリ名文字列の最初の文字までのオフセットを指定します。
- iFileOffset
- この構造体の開始点から File にセットされているファイル名文字列の最初の文字までのオフセットを指定します。
- iRemoteDBOffset
- この構造体の開始点から Remote にセットされているハンドヘルド データベース名文字列の最初の文字までのオフセットを指定します。
- iUsernameOffset
- この構造体の開始点から Username にセットされているユーザ名文字列の最初の文字までのオフセットを指定します。
- iTitleOffset
- この構造体の開始点から Name にセットされているタイトル文字列の最初の文字までのオフセットを指定します。
- iInfoOffset
- この構造体の開始点から Information にセットされている情報文字列の最初の文字までのオフセットを指定します。
コメント
CmConduitType 構造体はいくつかの文字列を含みます。各文字列は構造体フィールドの後に保存されます。この構造体は各文字列のオフセット フィールドを含みます; 各オフセットはこの構造体の開始点からその文字列の開始点までのバイト数を指定します。
- NOTE
- CmConduitType 構造体は CDK バージョン 6.0 以降では使用を推奨されなくなったいくつかのコンジット コンフィグレーション エントリのフィールドを含みます。PalmSource は代わりに CmConduitType2 を CmInstallConduitByStruct() や CmInstallSystemConduitByStruct() とともに使用することを推奨します。
この構造体を使ってのコンジットの登録についての更なる情報は、C/C++ Sync Suite Companion の 「単一の構造体を作成する」 を参照してください。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
CmConduitType2 構造体 ^TOP^
目的
あなたがコンジットを登録するときに渡す、あるいは、あなたがコンジットについての情報を要求したときにコンジット マネージャから渡されるコンジット登録情報を定義します。
宣言されている場所
CondMgr.h
Prototype
typedef struct { DWORD dwCreatorID; DWORD dwPriority; TCHAR szConduitPath[255]; TCHAR szLocalDirectory[255]; TCHAR szLocalFile[255]; TCHAR szRemoteDB[32]; TCHAR szTitle[255]; } CmConduitType2
フィールド
- dwCreatorID
- 登録するコンジットの作成者 ID を定義します。この値はコンジットの Creator コンフィグレーション エントリにセットされます。
- dwPriority
- HotSync マネージャが登録するコンジットを実行する優先順位を定義します。この値はコンジットの Priority コンフィグレーション エントリにセットされます。
- szConduitPath
- 登録するコンジットのフル パスとファイル名(またはファイル名だけ)を定義します。この値はコンジットの Conduit コンフィグレーション エントリにセットされます。
- szLocalDirectory
- 登録するコンジットのディレクトリ名を定義します。この値はコンジットの Directory コンフィグレーション エントリにセットされます。
- szLocalFile
- 登録するコンジットが同期をとるデスクトップ ファイルを定義します。この値はコンジットの File コンフィグレーション エントリにセットされます。
- szRemoteDB
- 登録するコンジットが同期をとるハンドヘルド上のデータベースの名前を定義します。コンジットはいくつのデータベースに対しても読み込み、書き込みを行えるので、この値はオプションであることに注意してください。この値はコンジットの Remote コンフィグレーション エントリにセットされます。
- szTitle
- 登録する表示名を定義します。この値はコンジットの Name コンフィグレーション エントリにセットされます。
コメント
この構造体はコンジット マネージャ バージョン 3 以降で導入される API によって、コンジットについての情報にアクセスするために使用されます。この構造体を使用する関数は以下の「参照」部でリスト アップされています。この構造体の各フィールドはコンジット コンフィグレーション エントリに対応します(表 A.1 を参照してください)。
この構造体は CmConduitType 構造体に比べて 2 つの長所があります。CmConduitType2 構造体は:
- サイズが固定されています。そのため、関数パラメータとして渡すのがより容易です。
- 必須のコンジット コンフィグレーション エントリとたいていのコンジットで使用されるいくつかのオプションのコンジット コンフィグレーション エントリだけを含みます。
互換性
- コンジット マネージャ バージョン: 3 以降
- Palm OS バージョン: すべて
参照
CmGetConduitByIndex(), CmGetSystemConduitByCreator(), CmGetSystemConduitByIndex(), CmInstallConduitByStruct(), CmInstallSystemConduitByStruct(), FmGetCurrentUserConduitByIndex(), FmGetSystemConduitByIndex()
CmDiscoveryInfoType 構造体 ^TOP^
目的
HotSync マネージャがどのようにコンジットを見つけ出すかについての情報を受け取ります。
宣言されている場所
CondMgr.h
Prototype
typedef struct { BOOL bDiscoverableViaFolder; BOOL bDiscoverableViaRegistry; BOOL bLoadable; } CmDiscoveryInfoType
フィールド
- bDiscoverableViaFolder
- コンジットがフォルダ登録である場合、つまりコンジット マネージャがシステムまたはユーザの Conduits フォルダの中でコンジットを見つけ出した場合、TRUE を受け取ります。
- bDiscoverableViaRegistry
- コンジットが通常通りの方法で登録されていた場合、つまり HotSync マネージャがコンジット コンフィグレーション エントリを参照することによってコンジットを見つけ出した場合、TRUE を受け取ります。
- bLoadable
- HotSync マネージャがコンジットのロードに成功できた場合、TRUE を受け取ります。
コメント
フィールド bDiscoverableViaFolder と bDiscoverableViaRegistry の中のブール値は互いに排他です。
互換性
- コンジット マネージャ バージョン: 3 以降
- Palm OS バージョン: すべて
参照
CmGetDiscoveryInfoByIndex(), CmGetSystemDiscoveryInfoByIndex()
CM_CREATORLIST_ITEM_TYPE 構造体 ^TOP^
目的
コンジットに関連付けられたクリエイタ ID を受け取ります。
宣言されている場所
CondMgr.h
Prototype
typedef struct { char szCreatorID[CM_CREATOR_ID_SIZE]; int iReserved; } CM_CREATORLIST_ITEM_TYPE typedef CM_CREATORLIST_ITEM_TYPE *CM_CREATORLIST_TYPE
フィールド
- szCreatorID
- コンジットに関連付けられたクリエイタ ID を受け取ります。
- iReserved
- 整数値を受け取ります。これは将来使用するために予約されています。
コメント
CM_CREATORLIST_TYPE は CmGetCreatorIDList によって返される CM_CREATORLIST_ITEM_TYPE 構造体の配列へのポインタとして定義されています。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
コンジット マネージャ定数 ^TOP^
この節では、あなたがコンジット マネージャ API で使用するプロセッサ定数の以下のグループについて説明します。
定数 | 説明 |
---|---|
コンジット情報タイプ | コンジットのタイプを定義します。コンジットのタイプはそのコンジットによって使用される情報の場所を定義します。 |
通信ポート | COM ポートを取得、セットするための接続のタイプを示します。 |
コンジット マネージャ バージョン | CmGetLibVersion() が返すコンジット マネージャのバージョン番号を定義します。 |
その他の定数 | コンジット マネージャで使用するその他の定数を定義します。 |
コンジット情報タイプ ^TOP^
目的
コンジットのタイプを定義します。コンジットのタイプはそのコンジットによって使用される情報の場所を定義します。
宣言されている場所
CondMgr.h
定数
- #define CONDUIT_APPLICATION 1
- コンジット情報がアプリケーション情報の場所に保存されていることを示します。
- #define CONDUIT_COMPONENT 0
- コンジット情報がコンポーネント情報の場所に保存されていることを示します。
- #define CONDUIT_CONDUITS 10
- 将来使用するためのものです。コンジット情報がコンジット集団の情報の場所に保存されていることを示します。
コメント
CmInstallCreator() または CmInstallConduit() を呼び出しているときにこれらの値の 1 つを指定します。ほとんどすべてのコンジットに対して、CONDUIT_APPLICATION を指定します。PalmSource は、代わりに CmInstallConduitByStruct() を使用することを推奨します。この関数はあなたがこれらの値の 1 つを指定することを必要としません。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
CmInstallCreator(), CmInstallConduit()
通信ポート ^TOP^
目的
COM ポートを取得、セットするための接続のタイプを示します。
宣言されている場所
CondMgr.h
定数
- #define DIRECT_COM_PORT 0
- HotSync マネージャのコンフィグレーション エントリの中の DirectComPort エントリを指定します。
- #define MODEM_COM_PORT 1
- HotSync マネージャのコンフィグレーション エントリの中の ModemComPort エントリを指定します。
- #define MAX_COM_PORT MODEM_COM_PORT
- 通信ポート定数の最大範囲を指定します。
コメント
直接 (ローカル) 接続またはモデム接続で使用されるポートの名前を取得 (またはセット) するかどうかを指定するために CmGetComPort() (または CmSetComPort()|C/C++ Sync Suite Reference601/11-3) にこれらの値の 1 つを渡します。これらの値はどの HotSync マネージャ コンフィグレーション エントリが読み込みまたは書き込みを行うかを指定します。
これらの値はシステム全体に対してセットされるのであり、Windows ユーザごとにセットされるのではないということに注意してください。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
CmGetComPort(), CmSetComPort()
コンジット マネージャ バージョン ^TOP^
目的
CmGetLibVersion() が返す可能性があるコンジット マネージャ バージョン番号を定義します。
宣言されている場所
CondMgr.h
定数
- #define CM_INITIAL_LIB_VERSION 0x0001
- コンジット マネージャ バージョン 1 によって返される値。
- #define CM_UPDATE_1 0x0002
- コンジット マネージャ バージョン 2 によって返される値。
- #define CM_UPDATE_2 0x0003
- コンジット マネージャ バージョン 3 によって返される値。このバージョンは HotSync マネージャ バージョン 6.0 以降とともに出荷されます。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
その他の定数 ^TOP^
目的
コンジット マネージャで使用されるその他の定数を定義します。
宣言されている場所
CondMgr.h
定数
- #define CM_CREATOR_ID_SIZE 8
- クリエイタ ID のサイズ (char の数)。この値はいくつかのデータ構造体の中でクリエイタ ID を保存するための文字配列のサイズを定義するために使用されます。
- #define CONDUIT_VERSION 100
- コンジット マネージャの CmConduitType 構造体の現在のバージョン。この値は CmGetLibVersion() によって返されるコンジット マネージャのバージョンではありません。
- #define CM_CONDUIT_BUFFER_OFFSET sizeof(CmConduitType)
- CmConduitType 構造体の開始点からのオフセットを定義します。
- #define CM_MIN_CONDUITTYPE_SIZE sizeof(CmConduitType)
- CmConduitType 構造体の最小サイズをを定義します。
- #define FILEINSTALLTYPE_SIZE sizeof(FileInstallType)
- FileInstallType 構造体のサイズを定義します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
コンジット マネージャ関数 ^TOP^
この節では、あなたがコンジットを登録して コンフィグレーション エントリ から情報を取得することを可能にする関数について説明します。
関数 | 説明 |
---|---|
CmConvertCreatorIDToString() | クリエイタ ID を DWORD から文字列に変換します。 |
CmConvertStringToCreatorID() | クリエイタ ID を文字列から DWORD に変換します。 |
CmGetBackupConduit() | 現在の Windows ユーザのためのバックアップ コンジットのパスまたはファイル名を取得します。 |
CmGetComPort() | HotSync マネージャがデスクトップ コンピュータ上の指定された接続タイプのために使用する COM ポートの名前を取得します。 |
CmGetConduitByCreator() | 与えられたコンジットのクリエイタ ID から現在の Windows ユーザのために登録されたコンジットについての情報を取得します。 |
CmGetConduitByIndex() | 与えられたコンジットのインデックスから現在の Windows ユーザのために登録されたコンジットについての情報を取得します。 |
CmGetConduitCount() | 現在の Windows ユーザのために HotSync マネージャに登録されているコンジットの数を返します。 |
CmGetConduitCreatorID() | 現在の Windows ユーザのために登録されたコンジットのクリエイタ ID を取得します。 |
CmGetCorePath() | 現在の Windows ユーザのための HotSync ユーザのディレクトリのパスを取得します。 |
CmGetCreatorArgument() | (使用を推奨されなくなりました) 指定されたコンジットのための Arguments コンフィグレーション エントリの値を取得します。 |
CmGetCreatorDirectory() | ユーザ登録コンジットがそれのユーザ データを保存するディレクトリの名前を取得します。 |
CmGetCreatorFile() | ユーザ登録コンジットのためのデータ ファイルの名前を取得します。 |
CmGetCreatorIDList() | 現在の Windows ユーザのために登録されているすべてのコンジットのクリエイタ ID のリストを取得します。 |
CmGetCreatorInfo() | (使用を推奨されなくなりました) ユーザ登録コンジットに関連付けられている文字列を取得します。 |
CmGetCreatorIntegrate() | (使用を推奨されなくなりました) 指定されたコンジットのための Integrate コンフィグレーション エントリの値を取得します。 |
CmGetCreatorModule() | (使用を推奨されなくなりました) 指定されたコンジットのための Module コンフィグレーション エントリの値を取得します。 |
CmGetCreatorName() | ユーザ登録コンジットのファイル名を取得します。 |
CmGetCreatorPriority() | ユーザ登録コンジットの実行優先順位を取得します。 |
CmGetCreatorRemote() | ユーザ登録コンジットに関連付けされているハンドヘルド上のデータベースの名前を取得します。 |
CmGetCreatorTitle() | ユーザ登録コンジットのディスプレイ名を取得します。 |
CmGetCreatorType() | (使用を推奨されなくなりました) 指定されたコンジットのタイプ - コンポーネントまたはアプリケーション - を返します。 |
CmGetCreatorUser() | (使用を推奨されなくなりました) 指定されたコンジットの Username コンフィグレーション エントリの値を取得します。 |
CmGetCreatorValueDword() | ユーザ登録コンジットの DWORD コンフィグレーション エントリ値を取得します。 |
CmGetCreatorValueString() | ユーザ登録コンジットの文字列コンフィグレーション エントリ値を取得します。 |
CmGetDiscoveryInfoByIndex() | HotSync マネージャがどのようにユーザ登録コンジットを見つけ出すのかについての情報を取得します。 |
CmGetHotSyncExecPath() | (使用を推奨されなくなりました) デスクトップ コンピュータ上の HotSync マネージャ実行ファイルのパスとファイル名を取得します。(サポート DLL のパスを取得するには HotSync.exe ファイル名を取り除きます。) |
CmGetLibVersion() | 現在ロードされている DLL からコンジット マネージャ API のバージョン番号を返します。 |
CmGetNotifierDll() | (使用を推奨されなくなりました) 通知機能 DLL の名前を取得します。 |
CmGetPCIdentifier() | デスクトップ コンピュータ上の現在の Windows ユーザの固有識別子を取得します。 |
CmGetSystemBackupConduit() | システムのためのバックアップ コンジットとして登録されているコンジットの名前を取得します。 |
CmGetSystemConduitByCreator() | 与えられたコンジットのクリエイタ ID からシステムのために登録されているコンジットについての情報を取得します。 |
CmGetSystemConduitByIndex() | 与えられたコンジットのインデックスからシステムのために登録されているコンジットについての情報を取得します。 |
CmGetSystemConduitCount() | システムのために HotSync マネージャに登録されているコンジットの数を返します。 |
CmGetSystemConduitCreatorID() | システムのために登録されているコンジットのクリエイタ ID を取得します。 |
CmGetSystemCreatorDirectory() | システム登録コンジットがそのコンジットのユーザ データを保存するディレクトリの名前を取得します。 |
CmGetSystemCreatorFile() | システム登録コンジットのためのデータ ファイルの名前を取得します。 |
CmGetSystemCreatorIDList() | システムのために登録されているすべてのコンジットのクリエイタ ID のリストを取得します。 |
CmGetSystemCreatorName() | システム登録コンジットのファイル名を取得します。 |
CmGetSystemCreatorPriority() | システム登録コンジットの実行優先順位を取得します。 |
CmGetSystemCreatorRemote() | システム登録コンジットに関連付けされているハンドヘルド上のデータベースの名前を取得します。 |
CmGetSystemCreatorTitle() | システム登録コンジットの表示名を取得します。 |
CmGetSystemCreatorValueDword() | システム登録コンジットのための DWORD コンフィグレーション エントリ値を取得します。 |
CmGetSystemCreatorValueString() | システム登録コンジットのための文字列コンフィグレーション エントリ値を取得します。 |
CmGetSystemDiscoveryInfoByIndex() | HotSync マネージャがシステム登録コンジットを発見する方法を取得します。 |
CmGetSystemHotSyncExecPath() | デスクトップ コンピュータ上の HotSync マネージャの実行形式ファイルのパスとファイル名を取得します。(サポート DLL のパスを取得するにはファイル名 HotSync.exe を取り除きます。) |
CmInstallConduit() | コンジットを現在の Windows ユーザのために HotSync マネージャに登録します。CmConduitType 構造体を使用します。 |
CmInstallConduitByStruct() | コンジットを現在の Windows ユーザのために HotSync マネージャに登録します。CmConduitType2 構造体を使用します。 |
CmInstallCreator() | 新しいコンジット クリエイタ ID を現在の Windows ユーザのために HotSync マネージャに登録します (登録を完了するには CmSetCreator...()|C/C++ Sync Suite Reference601/11-2 関数を呼び出すことが必要です)。 |
CmInstallSystemConduitByStruct() | コンジットをシステムのために HotSync マネージャに登録します。CmConduitType2 構造体を使用します。 |
CmInstallSystemCreator() | 新しいコンジット クリエイタ ID を現在のシステムのために HotSync マネージャに登録します (登録を完了するには CmSetSystemCreator...()|C/C++ Sync Suite Reference601/11-2 関数を呼び出すことが必要です)。 |
CmIsCurrentUserAdmin() | 現在のユーザが Windows 管理者権限を持っているかどうかを決定します。 |
CmRemoveConduitByCreatorID() | 与えられたコンジットのクリエイタ ID によって現在の Windows ユーザのために登録されているコンジットの登録を解除します。 |
CmRemoveConduitByIndex() | 与えられたコンジットのインデックスによって現在の Windows ユーザのために登録されているコンジットの登録を解除します。 |
CmRemoveSystemConduitByCreatorID() | 与えられたコンジットのクリエイタ ID によってシステムのために登録されているコンジットの登録を解除します。 |
CmRemoveSystemConduitByIndex() | 与えられたコンジットのインデックスによってシステムのために登録されているコンジットの登録を解除します。 |
CmRestoreHotSyncSettings() | (使用を推奨されなくなりました) HotSync マネージャ コンフィグレーション エントリ設定をデフォルト値に戻します。 |
CmSetBackupConduit() | 現在の Windows ユーザのためのバックアップ コンジットのパスまたはファイル名をセットします。 |
CmSetComPort() | HotSync マネージャがデスクトップ コンピュータの指定されたタイプの接続のために使用する COM ポートの名前をセットします。 |
CmSetCorePath() | (使用を推奨されなくなりました) 現在の Windows ユーザのための HotSync ユーザ ディレクトリのパスをセットします。 |
CmSetCreatorArgument() | (使用を推奨されなくなりました) 指定されたコンジットのための Arguments コンフィグレーション エントリの値をセットします。 |
CmSetCreatorDirectory() | ユーザ登録コンジットがそのコンジットのユーザ データを保存するディレクトリの名前をセットします。 |
CmSetCreatorFile() | ユーザ登録コンジットのためのデータ ファイルの名前をセットします。 |
CmSetCreatorInfo() | (使用を推奨されなくなりました) ユーザ登録コンジットに関連付けされる文字列をセットします。 |
CmSetCreatorIntegrate() | (使用を推奨されなくなりました) 指定されたコンジットのための Integrate コンフィグレーション エントリの値をセットします。 |
CmSetCreatorModule() | (使用を推奨されなくなりました) 指定されたコンジットのための Module コンフィグレーション エントリの値をセットします。 |
CmSetCreatorName() | ユーザ登録コンジットのファイル名をセットします。 |
CmSetCreatorPriority() | ユーザ登録コンジットのための実行優先順位をセットします。 |
CmSetCreatorRemote() | ユーザ登録コンジットに関連付けされるハンドヘルド上のデータベースの名前をセットします。 |
CmSetCreatorTitle() | ユーザ登録コンジットの表示名をセットします。 |
CmSetCreatorUser() | (使用を推奨されなくなりました) 指定されたコンジットのための Username コンフィグレーション エントリの値をセットします。 |
CmSetCreatorValueDword() | ユーザ登録コンジットのための DWORD コンフィグレーション エントリの値をセットします。 |
CmSetCreatorValueString() | ユーザ登録コンジットのための文字列コンフィグレーション エントリの値をセットします。 |
CmSetHotSyncExecPath() | (使用を推奨されなくなりました) 現在の Windows ユーザのための HotSync マネージャ実行形式ファイルのパスとファイル名をセットします。 |
CmSetNotifierDll() | (使用を推奨されなくなりました) 通知 DLL の名前をセットします。 |
CmSetPCIdentifier() | (使用を推奨されなくなりました) デスクトップ コンピュータ上の現在の Windows ユーザのための固有識別子をセットします。 |
CmSetSystemBackupConduit() | システムのためのバックアップ コンジットのパスまたはファイル名をセットします。 |
CmSetSystemCreatorDirectory() | システム登録コンジットがそのコンジットのユーザ データを保存するディレクトリの名前をセットします。 |
CmSetSystemCreatorFile() | システム登録コンジットのためのデータ ファイルの名前をセットします。 |
CmSetSystemCreatorName() | システム登録コンジットのファイル名をセットします。 |
CmSetSystemCreatorPriority() | システム登録コンジットのための実行優先順位をセットします。 |
CmSetSystemCreatorRemote() | システム登録コンジットに関連付けされるハンドヘルド状のデータベースの名前をセットします。 |
CmSetSystemCreatorTitle() | システム登録コンジットの表示名をセットします。 |
CmSetSystemCreatorValueDword() | システム登録コンジットのための DWORD コンフィグレーション エントリの値をセットします。 |
CmSetSystemCreatorValueString() | システム登録コンジットのための文字列コンフィグレーション エントリの値をセットします。 |
FmDisableCurrentUserConduitByIndex() | 与えれられたインデックスで現在の Windows ユーザの Conduits フォルダの中にあるコンジットを使用不可にします。 |
FmDisableCurrentUserConduitByPath() | 与えれられたコンジットのパスまたはファイル名で現在の Windows ユーザの Conduits フォルダの中にあるコンジットを使用不可にします。 |
FmDisableSystemConduitByIndex() | 与えれられたインデックスでシステムの Conduits フォルダの中にあるコンジットを使用不可にします。 |
FmDisableSystemConduitByPath() | 与えれられたコンジットのパスまたはファイル名でシステムの Conduits フォルダの中にあるコンジットを使用不可にします。 |
FmEnableCurrentUserConduitByPath() | 与えられたコンジットのパスまたはファイル名で現在の Windows ユーザの Disabled フォルダの中にあるコンジットを使用可能にします。 |
FmEnableSystemConduitByPath() | 与えられたコンジットのパスまたはファイル名でシステムの Disabled フォルダの中にあるコンジットを使用可能にします。 |
FmGetCurrentUserConduitByIndex() | 与えられたコンジットのインデックスで現在の Windows ユーザのために登録されているフォルダ ベース コンジットについての情報を取得します。 |
FmGetCurrentUserConduitCount() | 現在の Windows ユーザのために HotSync マネージャに登録されているフォルダ ベース コンジットの数を返します。 |
FmGetCurrentUserConduitFolder() | 現在の Windows ユーザの Conduits フォルダのパスを取得します。 |
FmGetCurrentUserDisabledConduitFolder() | 現在の Windows ユーザの Disabled フォルダのパスを取得します。 |
FmGetSystemConduitByIndex() | 与えられたコンジットのインデックスでシステムのために登録されているフォルダ ベース コンジットについての情報を取得します。 |
FmGetSystemConduitCount() | システムのために HotSync マネージャに登録されているフォルダ ベース コンジットの数を返します。 |
FmGetSystemConduitFolder() | システムの Conduits フォルダのパスを取得します。 |
FmGetSystemDisabledConduitFolder() | システムの Disabled フォルダのパスを取得します。 |
CmConvertCreatorIDToString 関数 ^TOP^
目的
クリエイタ ID を DWORD から文字列に変換します。
宣言されている場所
CondMgr.h
Prototype
int CmConvertCreatorIDToString ( DWORD dwID, TCHAR *pString, int *piSize )
パラメータ
- → dwID
- DWORD のクリエイタ ID。
- ← pString
- 文字バッファへのポインタ。返り時には、これは文字列のクリエイタ ID を保持しています。
- ←→ piSize
- pString によって参照される文字バッファのサイズを指定する整数値へのポインタ。返り時には、これは実際のサイズ - クリエイタ ID 文字列の TCHAR 数 - になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズです。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_BUFFER_TOO_SMALL
- あなたが提供したバッファのサイズが文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
- ERR_INVALID_CREATOR_ID
- 指定されたクリエイタ ID は有効なクリエイタ ID ではありません。
- ERR_INVALID_POINTER
- 指定されたポインタは有効なポインタではありません。
すべてのコンジット マネージャ エラー コードについての説明は、「コンジット マネージャ エラー コード」 を参照してください。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
CmConvertStringToCreatorID 関数 ^TOP^
目的
クリエイタ ID を文字列から DWORD に変換します。
宣言されている場所
CondMgr.h
Prototype
int CmConvertStringToCreatorID ( const TCHAR *pString, DWORD *pdwID )
パラメータ
- → pString
- 文字列のクリエイタ ID。これは 4 文字のクリエイタ ID でなければなりません。
- ← pdwID
- DWORD に変換されたクリエイタ ID。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_INVALID_CREATOR_ID
- 指定されたクリエイタ ID は有効なクリエイタ ID ではありません。
- ERR_INVALID_POINTER
- 指定されたポインタは有効なポインタではありません。
すべてのコンジット マネージャ エラー コードについての説明は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
他のコンジット マネージャ関数は文字列ではなく DWORD 値のクリエイタ ID をとります。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
CmGetBackupConduit 関数 ^TOP^
目的
現在の Windows ユーザのためのバックアップ コンジットのパスまたはファイル名を取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetBackupConduit ( TCHAR *pConduit, int *piSize )
パラメータ
- ← pConduit
- 文字バッファへのポインタ。返り時には、これはバックアップ コンジットとして使用されるコンジットのフル パスまたはファイル名を保持します。
- ←→ piSize
- pConduit によって参照される文字バッファのサイズを指定する整数値へのポインタ。返り時には、これはバックアップ コンジット名文字列の実際のサイズ - TCHAR の数 - になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_REGISTRY_ACCESS
- コンジット コンフィグレーション エントリにアクセスすることができません。
- ERR_BUFFER_TOO_SMALL
- あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
- ERR_INVALID_POINTER
- 指定されたポインタは有効なポインタではありません。
すべてのコンジット マネージャ エラー コードについての説明は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数は現在の Windows ユーザのために HotSync マネージャによって使用される HotSync Manager\BackupConduit コンフィグレーション エントリの値を取得します。システムのために登録されているバックアップ コンジットのパスまたはファイル名を取得するには、CmGetSystemBackupConduit() を使用します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
HotSync Manager\BackupConduit, CmSetBackupConduit(), CmGetSystemBackupConduit()
CmGetComPort 関数 ^TOP^
目的
HotSync マネージャがデスクトップ コンピュータ上の指定された接続タイプのために使用する COM ポートの名前を取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetComPort ( int iType, TCHAR *pPort, int *piSize )
パラメータ
- → iType
- 取得する COM ポートの接続タイプ。あなたは 「通信ポート」 で宣言されている値の 1 つを指定しなければなりません。
- ← pPort
- 文字バッファ。返り時には、これはポート名 - 例えば、"COM1" - を保持します。
- ←→ piSize
- pPort パラメータによって参照されるバッファのサイズ - TCHAR の数 - を指定します。返り時には、これはポート名文字列の実際のサイズ - TCHAR の数 - になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_REGISTRY_ACCESS
- コンジット コンフィグレーション エントリにアクセスすることができません。
- ERR_BUFFER_TOO_SMALL
- あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
- ERR_INVALID_POINTER
- 指定されたポインタは有効なポインタではありません。
- ERR_INVALID_COM_PORT_TYPE
- 指定された通信ポート タイプは有効ではありません。あなたは 「通信ポート」 で宣言されている値の 1 つを使用しなければなりません。
すべてのコンジット マネージャ エラー コードについての説明は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数はあなたが iType パラメータに指定した値に基づいてコンフィグレーション エントリの HotSync マネージャ部分から HotSync Manager\ModemComPort エントリか HotSync Manager\DirectComPort エントリのどちらかを取得します。これらの値は現在の Windows ユーザに対してのみセットされるということに注意してください。これらに相当するシステムに対する設定はありません。HotSync マネージャは新しい Windows ユーザに対してそれぞれデフォルト値をセットします。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
HotSync Manager\ModemComPort, HotSync Manager\DirectComPort
CmGetConduitByCreator 関数 ^TOP^
目的
与えられたコンジットのクリエイタ ID から現在の Windows ユーザのために登録されたコンジットについての情報を取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetConduitByCreator ( const char *pCreatorID, HANDLE *hStruct )
パラメータ
- → pCreatorID
- 文字列で提供するコンジットのクリエイタ ID。
- ← hStruct
- ハンドルへのポインタ。この関数は CmConduitType 構造体のために記憶装置を割り当て、データをその構造体に保存し、ハンドルを返します。記憶装置の割り当てを解除する責任はあなたにあります。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_NO_MEMORY
- リクエストされた操作を実行するにはメモリが不足しています。
- ERR_REGISTRY_ACCESS
- コンフィグレーション エントリにアクセスすることができません。
- ERR_INVALID_CREATOR_ID
- 指定されたクリエイタ ID は有効なクリエイタ ID ではありません。
- ERR_INVALID_POINTER
- 指定されたポインタは有効なポインタではありません。
すべてのコンジット マネージャ エラー コードについての説明は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数は記憶装置を割り当て、その記憶装置のハンドルを返します。あなたは処理を終了した後にそのハンドルの割り当てを解除しなければなりません。
コンジット マネージャは GMEM_MOVEABLE フラグで GlobalAlloc() 関数を呼び出すことによって hStruct ハンドルに割り当てを行うということに注意してください。ハンドルをポインタに変換するには、あなたが GlobalLock() 関数と GlobalUnlock() 関数を使用する必要があります。例えば以下のように:
CmConduitType *pConduit = (CmConduitType*) GlobalLock(*hStruct); GlobalUnlock(*hStruct);
この関数は現在の Windows ユーザのために登録されているコンジットについての情報を取得します。システムのために登録されているコンジットに対するこの情報 (訳者: CmConduitType 構造体) を取得するには、CmGetSystemConduitByCreator() を呼び出します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
CmConduitType, CmInstallConduitByStruct(), CmGetConduitByIndex(), CmGetSystemConduitByCreator()
CmGetConduitByIndex 関数 ^TOP^
目的
与えられたコンジットのインデックスから現在の Windows ユーザのために登録されたコンジットについての情報を取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetConduitByIndex ( int iIndex, CmConduitType2 &sConduitInfo )
パラメータ
- → iIndex
- 現在の Windows ユーザのために登録されているコンジットの 0 ベース インデックス。インデックスの最大値を決定するには CmGetConduitCount() を呼び出します。
- ← sConduitInfo
- 指定されたコンジットについて説明する CmConduitType2 構造体への参照。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_INDEX_OUT_OF_RANGE
- 指定されたインデックス値は範囲外です。
すべてのコンジット マネージャ エラー コードについての説明は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数は現在の Windows ユーザのために登録されているコンジットについての情報を取得します。システムのために登録されているコンジットに対するこの情報 (訳者: CmConduitType2 構造体) を取得するには、CmGetSystemConduitByIndex() を呼び出します。
互換性
- コンジット マネージャ バージョン: 3 以降
- Palm OS バージョン: すべて
参照
CmConduitType2, CmInstallConduitByStruct(), CmGetConduitCount(), CmGetSystemConduitByIndex(), CmGetConduitByCreator()
CmGetConduitCount 関数 ^TOP^
目的
現在の Windows ユーザのために HotSync マネージャに登録されているコンジットの数を返します。
宣言されている場所
CondMgr.h
Prototype
int CmGetConduitCount ( void )
パラメータ
ありません。
返り値
成功した場合、登録されているコンジットの数を返します。
失敗した場合、以下の非 0 のエラー コード値を返します:
- ERR_REGISTRY_ACCESS
すべてのコンジット マネージャ エラー コードについての説明は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
返されるコンジットは現在の Windows ユーザのために登録されているコンジットすべてです。この数にはユーザの Conduits フォルダに置かれることによって登録されたコンジット (フォルダ登録) とコンフィグレーション エントリによって登録されたコンジット (通常通りの登録) が含まれます。この数にはバックアップ コンジット、インストール コンジットを含まれず、システム登録コンジットも含まれません。システムのために登録されているコンジットに対するこの情報 (訳者: 登録されているコンジット数) を取得するには、CmGetSystemConduitCount() を呼び出します。
あなたはこの数を使って有効なインデックス値の範囲を決定することができ、それを CmGetConduitByIndex() で使用することができます。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
CmGetSystemConduitCount(), CmGetConduitByIndex()
CmGetConduitCreatorID 関数 ^TOP^
目的
現在の Windows ユーザのために登録されたコンジットのクリエイタ ID を取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetConduitCreatorID ( int iIndex, char *pCreatorID, int *piSize )
パラメータ
- → iIndex
- 現在の Windows ユーザのために登録されいてるコンジットの 0 ベースのインデックス。インデックスの最大値を決定するには CmGetConduitCount() を呼び出します。
- ← pCreatorID
- 文字バッファ。返り時には、これはクリエイタ ID 文字列を保持しています。
- ←→ piSize
- pCreatorID パラメータによって参照されるバッファのサイズ (char の数) を指定する整数へのポインタ。返り時には、これはクリエイタ ID 文字列の実際のサイズ (char の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_REGISTRY_ACCESS
- ERR_BUFFER_TOO_SMALL
- あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
すべてのコンジット マネージャ エラー コードについての説明は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
コンフィグレーション エントリの中で最初に定義されているコンジットを指定するには 0 を指定します。その後に続く各コンジットに対してはインデックス値を +1 します。
この関数は現在の Windows ユーザのために登録されているコンジットについての情報を取得します。システムのために登録されているコンジットに対してこの情報 (訳者: クリエイタ ID) を取得するには、CmGetSystemConduitCreatorID() を呼び出します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
CmGetConduitCount(), CmGetSystemConduitCreatorID(), CmInstallConduitByStruct()
CmGetCorePath 関数 ^TOP^
目的
現在の Windows ユーザのための HotSync ユーザのディレクトリのパスを取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetCorePath ( TCHAR *pPath, int *piSize )
パラメータ
- ← pPath
- 文字バッファへのポインタ。返り時には、これはパスを保持しています。
- ←→ piSize
- pPath パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これはパス文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_BUFFER_TOO_SMALL
- あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
- ERR_REGISTRY_ACCESS
- ERR_INVALID_POINTER
すべてのコンジット マネージャ エラー コードについての説明は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数は現在の Windows ユーザのための Core\Path コンフィグレーション エントリの値を取得します。このパスは各 Windows ユーザで異なるかもしれないため、「システム レベル」パスとは対応しません。
コンジット マネージャ バージョン 3 以降は複数の Windows ユーザを認識します。そのため、各 Windows ユーザは別々の Core\Path 値を持たなければなりません。ユーザ データの保管場所を Windows 標準に合わせるには、通常の値は C:\Documents and Settings\<WinUsername>\My Documents\Palm OS Desktop です。あなたが HotSync ユーザのディレクトリのフル パスを必要とする場合、UmGetUserDirectory() を呼び出し、得られたパスを Core\Path 値に付加します。
- NOTE
- CmGetCorePath() によって返されるパスは必ずしも CondMgr.dll や他のサポート DLL の場所ではありません。これらの DLL はユーザ ディレクトリとは異なるディレクトリの中にある可能性があります。HotSync ユーザ ディレクトリの場所を決定するためだけに CmGetCorePath() を使用してください。
HotSync マネージャ、CondMgr.dll、その他の DLL のパスを決定するには、この関数の代わりに CmGetHotSyncExecPath() を呼び出します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
CmGetCreatorArgument 関数 ^TOP^
目的
(使用を推奨されなくなりました) 指定されたコンジットのための Arguments コンフィグレーション エントリの値を取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetCreatorArgument ( const char *pCreatorID, TCHAR *pArgument, int *piSize )
パラメータ
- → pCreatorID
- コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Arguments 値を取得しようとしています。
- ← pArgument
- 文字列バッファへのポインタ。返り時には、これは指定されたコンジットの Arguments コンフィグレーション エントリの値になります。
- ←→ piSize
- pArguments パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは Arguments 文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_AMBIGUOUS_CREATORID
- ERR_NO_CONDUIT
- ERR_REGISTRY_ACCESS
- ERR_BUFFER_TOO_SMALL
- あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
- ERR_INVALID_CREATOR_ID
- ERR_INVALID_POINTER
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
CDK 6.0 では、この関数は使用を推奨されなくなりました。この値 (訳者: Arguments) を使用する HotSync マネージャのバージョンはありません。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
Arguments, CmSetCreatorArgument()
CmGetCreatorDirectory 関数 ^TOP^
目的
ユーザ登録コンジットがそのコンジットのユーザ データを保存するディレクトリの名前を取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetCreatorDirectory ( const char *pCreatorID, TCHAR *pDirectory, int *piSize )
パラメータ
- → pCreatorID
- コンジットのクリエイタ ID。あなたはこのコンジットの Directory 値を取得しようとしています。
- ← pDirectory
- 文字列バッファへのポインタ。返り時には、これは指定されたコンジットの Directory コンフィグレーション エントリの値になります。
- ←→ piSize
- pDirectory パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは Directory 文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_AMBIGUOUS_CREATORID
- ERR_NO_CONDUIT
- ERR_REGISTRY_ACCESS
- ERR_BUFFER_TOO_SMALL
- あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
- ERR_VALUE_NOT_FOUND
- ERR_INVALID_CREATOR_ID
- ERR_INVALID_POINTER
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数は指定されたコンジットの Directory コンフィグレーション エントリの値を取得します。ディレクトリ文字列は現在の HotSync ユーザのディレクトリ下にあるディレクトリ - これはコンジットがそのコンジットのユーザ データとサポート ファイルを保存するために作成します - を指定します。例えば、Directory の値が DateBook であり、Core\Path の値が通常の値である場合、このコンジットのデータ ディレクトリへのフル パスは以下のようになります:
C:\Documents and Settings\<WinUsername>\My Documents \Palm OS Desktop\<HotSyncUsername>\DateBook
この関数は現在の Windows ユーザのために登録されているコンジットについての情報を取得します。システムのために登録されているコンジットに対するこの情報 (訳者: ユーザ データを保存するディレクトリ名) を取得するには、この関数の代わりに CmGetSystemCreatorDirectory() を呼び出します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
Directory, CmSetCreatorDirectory(), CmGetSystemCreatorDirectory()
CmGetCreatorFile 関数 ^TOP^
目的
ユーザ登録コンジットのためのデータ ファイルの名前を取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetCreatorFile ( const char *pCreatorID, TCHAR *pFile, int *piSize )
パラメータ
- → pCreatorID
- コンジットのクリエイタ ID 文字列。あなたはこのコンジットの File 値を取得しようとしています。
- ← pFile
- 文字バッファへのポインタ。返り時には、これは File コンフィグレーション エントリの値を保持しています。
- ←→ piSize
- pFile パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは File 文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_AMBIGUOUS_CREATORID
- ERR_NO_CONDUIT
- ERR_REGISTRY_ACCESS
- ERR_BUFFER_TOO_SMALL
- あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
- ERR_VALUE_NOT_FOUND
- ERR_INVALID_CREATOR_ID
- ERR_INVALID_POINTER
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数は指定されたコンジットの File コンフィグレーション エントリの値を取得します。ファイル文字列はハンドヘルド データベースと同期されるデスクトップ ファイルの名前を指定します。このファイルの位置はどこにでもなり得ますが、通例では CmGetCreatorDirectory() によって返されるディレクトリの中になります。
この関数は現在の Windows ユーザのために登録されているコンジットについての情報を取得します。システムのために登録されているコンジットに対するこの情報 (訳者: ユーザ登録コンジットのためのデータ ファイルの名前) を取得するには、この関数の代わりに CmGetSystemCreatorFile() を呼び出します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
File, CmSetCreatorFile(), CmGetSystemCreatorFile()
CmGetCreatorIDList 関数 ^TOP^
目的
現在の Windows ユーザのために登録されているすべてのコンジットのクリエイタ ID のリストを取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetCreatorIDList ( CM_CREATORLIST_TYPE pCreatorList, int *piSize )
パラメータ
- → pCreatorList
- クリエイタ ID を保持している CM_CREATORLIST_ITEM_TYPE 構造体の配列へのポインタ。
- ←→ piSize
- pCreatorList パラメータによって参照される配列の中にあるエントリの数を指定する整数へのポインタ。返り時には、これは配列の中にあるアイテムの実際の数になります。配列が小さすぎるためにこの関数が失敗した場合、返り時の piSize の値は必要とされる配列アイテム数になります。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_REGISTRY_ACCESS
- ERR_BUFFER_TOO_SMALL
- あなたが提供した配列のサイズはクリエイタ ID アイテムを保持するには小さすぎます。そのため、この関数は必要とされるアイテム数を piSize パラメータに返します。
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数はタイプ CM_CREATORLIST_ITEM_TYPE の構造体の配列への CM_CREATORLIST_TYPE ポインタ経由でクリエイタ ID のリストを返します。
この関数は現在の Windows ユーザのために登録されているコンジットについての情報を取得します。システムのために登録されているコンジットに対するこの情報 (訳者: コンジットのクリエイタ ID のリスト) を取得するには、この関数の代わりに CmGetSystemCreatorIDList() を呼び出します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
CM_CREATORLIST_ITEM_TYPE, CmGetSystemCreatorIDList(), CmInstallConduitByStruct()
CmGetCreatorInfo 関数 ^TOP^
目的
(使用を推奨されなくなりました) ユーザ登録コンジットに関連付けられている文字列を取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetCreatorInfo ( const char *pCreatorID, TCHAR *pInfo, int *piSize )
パラメータ
- → pCreatorID
- コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Information 値を取得しようとしています。
- ← pInfo
- 文字バッファへのポインタ。返り時には、これは指定されたコンジットの Information コンフィグレーション エントリの値になります。
- ←→ piSize
- pInfo パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは Information 文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_AMBIGUOUS_CREATORID
- ERR_NO_CONDUIT
- ERR_REGISTRY_ACCESS
- ERR_BUFFER_TOO_SMALL
- あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
- ERR_INVALID_CREATOR_ID
- ERR_INVALID_POINTER
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
CDK 6.0 では、この関数は使用を推奨されなくなりました。この値 (訳者: Information) を使用する HotSync マネージャのバージョンはありません。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
Information, CmSetCreatorInfo()
CmGetCreatorIntegrate 関数 ^TOP^
目的
(使用を推奨されなくなりました) 指定されたコンジットのための Integrate コンフィグレーション エントリの値を取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetCreatorIntegrate ( const char *pCreatorID, DWORD *pdwIntegrate )
パラメータ
- → pCreatorID
- コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Integrate 値を取得しようとしています。
- ← pdwIntegrate
- DWORD 値へのポインタ。返り時には、これは指定されたコンジットの Integrate コンフィグレーション エントリの値になります。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_AMBIGUOUS_CREATORID
- ERR_NO_CONDUIT
- ERR_REGISTRY_ACCESS
- ERR_INVALID_CREATOR_ID
- ERR_INVALID_POINTER
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
CDK 6.0 では、この関数は使用を推奨されなくなりました。この値 (訳者: Integrate) を使用する HotSync マネージャのバージョンはありません。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
Integrate, CmSetCreatorIntegrate()
CmGetCreatorModule 関数 ^TOP^
目的
(使用を推奨されなくなりました) 指定されたコンジットのための Module}} コンフィグレーション エントリの値を取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetCreatorModule ( const char *pCreatorID, TCHAR *pModule, int *piSize )
パラメータ
- → pCreatorID
- コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Module 値を取得しようとしています。
- ← pModule
- 文字バッファへのポインタ。返り時には、これは指定されたコンジットの Module コンフィグレーション エントリの値になります。
- ←→ piSize
- pModule パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは Module 文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_AMBIGUOUS_CREATORID
- ERR_NO_CONDUIT
- ERR_REGISTRY_ACCESS
- ERR_BUFFER_TOO_SMALL
- あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
- ERR_INVALID_CREATOR_ID
- ERR_INVALID_POINTER
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
CDK 6.0 では、この関数は使用を推奨されなくなりました。この値 (訳者: Module) を使用する HotSync マネージャのバージョンはありません。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
CmGetCreatorName 関数 ^TOP^
目的
ユーザ登録コンジットのファイル名を取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetCreatorName ( const char *pCreatorID, TCHAR *pConduitName, int *piSize )
パラメータ
- → pCreatorID
- コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Conduit 値を取得しようとしています。
- ← pConduitName
- 文字バッファへのポインタ。返り時には、これは指定されたコンジットの Conduit コンフィグレーション エントリの値になります。
- ←→ piSize
- pConduit パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは Conduit 文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_AMBIGUOUS_CREATORID
- ERR_NO_CONDUIT
- ERR_REGISTRY_ACCESS
- ERR_BUFFER_TOO_SMALL
- あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
- ERR_INVALID_CREATOR_ID
- ERR_INVALID_POINTER
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数は指定されたコンジットの Conduit コンフィグレーション エントリの値を取得します。この値は指定されたクリエイタ ID で登録されているコンジット DLL のファイル名です - 例えば、ToDoCond.dll はクリエイタ ID 'todo' で登録されています。
この関数は現在の Windows ユーザのために登録されているコンジットについての情報を取得します。システムのために登録されているコンジットに対するこの情報 (訳者: コンジット DLL のファイル名) を取得するには、この関数の代わりに CmGetSystemCreatorName() を呼び出します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
Conduit, CmSetCreatorName(), CmGetSystemCreatorName()
CmGetCreatorPriority 関数 ^TOP^
目的
ユーザ登録コンジットの実行優先順位を取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetCreatorPriority ( const char *pCreatorID, DWORD *pdwPriority )
パラメータ
- → pCreatorID
- コンジットのクリエイタ ID。あなたはこのコンジットの Priority 値を取得しようとしています。
- ← pdwPriority
- DWORD 値へのポインタ。返り時には、これは指定されたコンジットの Priority コンフィグレーション エントリの値になります。これは 0 から 4 までの値です。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_AMBIGUOUS_CREATORID
- ERR_NO_CONDUIT
- ERR_REGISTRY_ACCESS
- ERR_INVALID_CREATOR_ID
- ERR_INVALID_POINTER
- ERR_VALUE_NOT_FOUND
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数は指定されたコンジットの Priority コンフィグレーション エントリの値を取得します。HotSync マネージャはコンジットを実行する順番 - つまり、HotSync マネージャがコンジットの OpenCondui() エントリ ポイントを呼び出す順番 - を決定するために優先順位値を使用します。HotSync マネージャは 0 の値を持つコンジットを最初に実行し、4 の値を持つコンジットを最後に実行します。
この関数は現在の Windows ユーザのために登録されているコンジットについての情報を取得します。システムのために登録されているコンジットに対するこの情報 (訳者: コンジット実行優先順位) を取得するには、この関数の代わりに CmGetSystemCreatorPriority() を呼び出します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
Priority, CmSetCreatorPriority(), CmGetSystemCreatorPriority()
CmGetCreatorRemote 関数 ^TOP^
目的
ユーザ登録コンジットに関連付けされているハンドヘルド上のデータベースの名前を取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetCreatorRemote ( const char *pCreatorID, TCHAR *pRemoteDB, int *piSize )
パラメータ
- → pCreatorID
- コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Remote 値を取得しようとしています。
- ← pRemoteDB
- 文字バッファへのポインタ。返り時には、これは指定されたコンジットの Remote コンフィグレーション エントリの値になります。
- ←→ piSize
- pRemoteDB パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは Remote 文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_AMBIGUOUS_CREATORID
- ERR_NO_CONDUIT
- ERR_REGISTRY_ACCESS
- ERR_BUFFER_TOO_SMALL
- あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
- ERR_VALUE_NOT_FOUND
- ERR_INVALID_CREATOR_ID
- ERR_INVALID_POINTER
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数は指定されたコンジットの Remote コンフィグレーション エントリの値を取得します。この値はこのコンジットに関連付けされているハンドヘルド上の単一のデータベースに名前をつけます。
- NOTE
- コンジットはハンドヘルド上の複数のデータベースにアクセスできますが、CmGetCreatorRemote() はハンドヘルド データベース名を 1 つだけ返します: このコンジットのための Remote コンフィグレーション エントリの中で指定されている (1 つの) 名前です。あなたがこのコンフィグレーション エントリを使うかどうかを決定する手助けとして、"Remote" の説明を参照してください。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
Remote, CmSetCreatorRemote(), CmGetSystemCreatorRemote()
CmGetCreatorTitle 関数 ^TOP^
目的
ユーザ登録コンジットのディスプレイ名を取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetCreatorTitle ( const char *pCreatorID, TCHAR *pTitle, int *piSize )
パラメータ
- → pCreatorID
- コンジットのクリエイタ ID 文字列。あなたはこのコンジットの Name 値を取得しようとしています。
- ← pTitle
- 文字バッファへのポインタ。返り時には、これは指定されたコンジットの Name コンフィグレーション エントリの値になります。
- ←→ piSize
- pTitle パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは Name 文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_AMBIGUOUS_CREATORID
- ERR_NO_CONDUIT
- ERR_REGISTRY_ACCESS
- ERR_BUFFER_TOO_SMALL
- あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
- ERR_VALUE_NOT_FOUND
- ERR_INVALID_CREATOR_ID
- ERR_INVALID_POINTER
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数は指定されたコンジットの Name コンフィグレーション エントリの値を取得します。この値が NULL ではない場合、HotSync マネージャはそれを Custom ダイアログ ボックスと HotSync Progress ダイアログ ボックスでコンジットの表示名として使用します。この値が NULL である場合、HotSync マネージャはコンジットの GetConduitInfo() エントリ ポイントによって返される値を使用し、それが失敗した場合はコンジットの GetConduitName() エントリ ポイントを使用します。
この関数は現在の Windows ユーザのために登録されているコンジットについての情報を取得します。システムのために登録されているコンジットに対するこの情報 (訳者: コンジットの表示名) を取得するには、この関数の代わりに CmGetSystemCreatorTitle() を呼び出します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
Name, CmSetCreatorTitle(), CmGetSystemCreatorTitle()
CmGetCreatorType 関数 ^TOP^
目的
(使用を推奨されなくなりました) 指定されたコンジットのタイプ - コンポーネントまたはアプリケーション - を返します。
宣言されている場所
CondMgr.h
Prototype
int CmGetCreatorType ( const char *pCreator )
パラメータ
- → pCreator
- コンジットのクリエイタ ID 文字列。あなたはこのコンジットのタイプ値を取得しようとしています。
返り値
成功した場合、「コンジット情報タイプ」 で説明されているコンジット タイプ定数値の 1 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_NO_CONDUIT
- ERR_REGISTRY_ACCESS
- ERR_INVALID_CREATOR_ID
- ERR_INVALID_POINTER
コメント
CDK 6.0 では、この関数は使用を推奨されなくなりました。この値 (訳者: ??。「コンジット情報タイプ」 は使用を推奨されなくなった定数ではないが?) を使用する HotSync マネージャのバージョンはありません。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
CmGetCreatorUser 関数 ^TOP^
目的
(使用を推奨されなくなりました) 指定されたコンジットの Username コンフィグレーション エントリの値を取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetCreatorUser ( const char *pCreatorID, TCHAR *pUsername, int *piSize )
パラメータ
- → pCreatorID
- コンジットのクリエイタ ID。あなたはこのコンジットの Username 値を取得しようとしています。
- ← pUsername
- 文字バッファへのポインタ。返り時には、これは指定されたコンジットの Username コンフィグレーション エントリの値になっています。
- ←→ piSizepiSize
- pUsername パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは Username 文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_AMBIGUOUS_CREATORID
- ERR_NO_CONDUIT
- ERR_REGISTRY_ACCESS
- ERR_BUFFER_TOO_SMALL
- あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
- ERR_INVALID_CREATOR_ID
- ERR_INVALID_POINTER
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
CDK 6.0 では、この関数は使用を推奨されなくなりました。この値 (訳者: Username) を使用する HotSync マネージャのバージョンはありません。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
CmGetCreatorValueDword 関数 ^TOP^
目的
ユーザ登録コンジットの DWORD コンフィグレーション エントリ値を取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetCreatorValueDword ( const char *pCreatorID, TCHAR *pValue, DWORD *dwValue, DWORD dwDefault )
パラメータ
- → pCreatorID
- コンジットのクリエイタ ID 文字列。あなたはこのコンジットのコンフィグレーション エントリ値を取得しようとしています。
- → pValue
- コンフィグレーション エントリ名。
- ← dwValue
- 返り時には、これは pValue によって指定されたコンフィグレーション エントリの値を保持しています。
- → dwDefault
- 指定された pValue 値がコンフィグレーション エントリの中で見つからなかった場合に dwValue に返されるデフォルトの値。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_AMBIGUOUS_CREATORID
- ERR_NO_CONDUIT
- ERR_REGISTRY_ACCESS
- ERR_INVALID_CREATOR_ID
- ERR_INVALID_POINTER
- ERR_VALUE_NOT_FOUND
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数はコンジットのコンフィグレーション エントリから DWORD 値を取得します。この関数は名前によってコンジット コンフィグレーション エントリ値を取得する汎用関数です。あなたはあなた自身が使用するために CmSetCreatorValueDword() で作成したコンフィグレーション エントリの値を取得するためにこの関数を使用できます。
コンジット マネージャが pValue で指定されたコンフィグレーション エントリ名を見つけられなかった場合、この関数は dwValue を dwDefault の値に等しくして 0 (成功) を返します。しかしながら、pCreatorID で指定されたコンジットが存在しない場合、この関数は dwValue を dwDefault に等しくすることはせず、エラーを返します。
この関数は現在の Windows ユーザのために登録されているコンジットについての情報を取得します。システムのために登録されているコンジットに対するこの情報 (訳者: コンコンフィグレーション エントリ) を取得するには、この関数の代わりに CmGetSystemCreatorValueDword() を呼び出します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
CmSetCreatorValueDword(), CmGetSystemCreatorValueDword(), CmGetCreatorValueString()
CmGetCreatorValueString 関数 ^TOP^
目的
ユーザ登録コンジットの文字列コンフィグレーション エントリ値を取得します。
宣言されている場所
CondMgr.h
Prototype
int CmGetCreatorValueString ( const char *pCreatorID, TCHAR *pValue, TCHAR *pString, int *piSize, TCHAR *pDefault )
パラメータ
- → pCreatorID
- コンジットのクリエイタ ID 文字列。あなたはこのコンジットのコンフィグレーション エントリ値を取得しようとしています。
- → pValue
- コンフィグレーション エントリ名。
- ← pString
- 文字バッファへのポインタ。返り時には、これは pValue によって指定されたコンフィグレーション エントリの値になっています。
- ←→ piSize
- pString パラメータによって参照されるバッファのサイズ (TCHAR の数) を指定する整数へのポインタ。返り時には、これは文字列の実際のサイズ (TCHAR の数) になります。文字列バッファが小さすぎるためにこの関数が失敗した場合、返り時の piSize の値はバッファに必要とされるサイズになります。
- → pDefault
- 指定された pValue 名がコンフィグレーション エントリの中に見つからなかった場合に pString に返されるデフォルトの値。
返り値
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コード値の 1 つを返します:
- ERR_AMBIGUOUS_CREATORID
- ERR_NO_CONDUIT
- ERR_REGISTRY_ACCESS
- ERR_BUFFER_TOO_SMALL
- あなたが提供したバッファのサイズは文字列を保持するには小さすぎます。そのため、この関数は必要とされるサイズを piSize パラメータに返します。
- ERR_INVALID_CREATOR_ID
- ERR_INVALID_POINTER
エラー コードについての更なる情報は、「コンジット マネージャ エラー コード」 を参照してください。
コメント
この関数はコンジットのコンフィグレーション エントリから文字列値を取得します。この関数は名前によってコンジット コンフィグレーション エントリ値を取得する汎用関数です。あなたはあなた自身が使用するために CmSetCreatorValueString() で作成したコンフィグレーション エントリの値を取得するためにこの関数を使用できます。
コンジット マネージャが pValue で指定されたコンフィグレーション エントリ名を見つけられなかった場合、この関数はデフォルト値を戻して (pString を pDefault の値に等しくして)、0 (成功) を返します。しかしながら、pCreatorID で指定されたコンジットが存在しない場合、この関数はデフォルト値を戻さず、エラーを返します。
この関数は現在の Windows ユーザのために登録されているコンジットについての情報を取得します。システムのために登録されているコンジットに対するこの情報 (訳者: コンコンフィグレーション エントリ) を取得するには、この関数の代わりに CmGetSystemCreatorValueString() を呼び出します。
互換性
- コンジット マネージャ バージョン: 2 以降
- Palm OS バージョン: すべて
参照
CmSetCreatorValueString(), CmGetSystemCreatorValueString(), CmGetCreatorValueDword()