Palm Programmer's Laboratory
Palm OS Programmer's API Reference/61
この章の索引
- 接続マネージャ データ タイプ
- 接続マネージャ定数
- 接続マネージャ関数
- CncAddProfile
- CncDefineParamID
- CncDeleteProfile
- CncGetParamType
- CncGetProfileInfo
- CncGetProfileList
- CncGetSystemFlagBitnum
- CncGetTrueParamID
- CncIsFixedLengthParamType
- CncIsSystemFlags
- CncIsSystemRange
- CncIsThirdPartiesRange
- CncIsVariableLengthParamType
- CncProfileCloseDB
- CncProfileCount
- CncProfileCreate
- CncProfileDelete
- CncProfileGetCurrent
- CncProfileGetIDFromIndex
- CncProfileGetIDFromName
- CncProfileGetIndex
- CncProfileOpenDB
- CncProfileSetCurrent
- CncProfileSettingGet
- CncProfileSettingSet
61 接続マネージャ
接続マネージャは、他のアプリケーションが接続パネルの中に保持される接続プロファイルへのアクセス、追加、削除することを可能にします。
この章では、ヘッダ ファイル ConnectionMgr.h で宣言されている接続マネージャ API のための参照資源を提供します:
追加情報は、Palm OS Programmer's Companion, vol. II の「シリアル通信」を参照してください。
接続マネージャ データ タイプ ^TOP^
CncProfileID Typedef ^TOP^
目的
CncProfileID タイプは接続マネージャ プロファイル データベースの中の固有の接続プロファイルを特定します。この ID をいくつかの接続マネージャ関数にパラメータとして渡すことができます。接続のプロファイル ID を CncProfileGetIDFromName() または CncProfileGetIDFromIndex() を使って取得することができます。
Prototype
typedef UInt32 CncProfileID;
互換性
Connection Manager Feature Set が満たされる場合にのみ、定義されます。
接続マネージャ定数 ^TOP^
General Profile Parameters ^TOP^
接続マネージャは、あらかじめインストールされている接続プロファイルの中の各パラメータを表す以下の定数を定義します。すべてのパラメータがすべてのプロファイル タイプに対して機能するわけではありません。
| パラメータ名 | パラメータ タイプ | 説明 |
|---|---|---|
| kCncParamBaud | UInt32 | 接続に使用されるボー レート。 |
| kCncParamBluetoothDeviceAddr | バッファ | Bluetooth ポートを通して接続されるハンドヘルド デバイスの 48 ビット アドレス（BD_ADDR）。このパラメータは、kCncParamPort が Bluetooth ポートを指定する場合にのみ、有効です。 |
| kCncParamBluetoothDeviceName | 文字列 | Bluetooth ポートを通して接続されるハンドヘルド デバイスの名前。デバイス名は UTF-8 文字エンコードを使用します。このパラメータは、kCncParamPort が Bluetooth ポートを指定する場合にのみ、有効です。 |
| kCncParamCountryIndex | UInt16 | 国名を提供する kCncParamIntlModemCountryStringList とこのプロファイルのためのリセット コマンドを提供する kCncParamIntlModemResetStringList によって返される文字列のリストのインデックス。 |
| kCncParamDeviceKind | UInt16 | 作成される接続のタイプ（一般のシリアル接続、モデムへの接続、電話への接続など）。この値は Device Kinds の 1 つです。 |
| kCncParamDialingMode | UInt8 | モデム プロファイルのためのダイアル モード。1 はパルス ダイアル。0 はタッチトーン。 |
| kCncParamFlowControl | UInt16 | フロー制御設定（ハードウェア ハンドシェイク）。0 はフロー制御設定がボー レート次第で使用可能、使用不可になることを示します。この設定を選択した場合、ボー レートが 2400 より大きい場合にフロー制御がオンになります。1 はフロー制御が常にオン、2 はフロー制御が常にオフであることを示します。このパラメータは電話プロファイルには適用されません。 |
| kCncParamInitString | 文字列 | モデムと電話プロファイルのための、接続を初期化するために送られるコマンドを保持する null で終了する文字列。接続パネルは、初期化文字列をプロファイルに保存する前に、初期化文字列からすべてのキャリッジ リターン（CR）または他の制御文字を削除します。 |
| kCncParamIntlModemCountryStringList | バッファ | モデム プロファイルのための、あり得る国のリストを保持するデータ バッファ。このリストが保持する国の中では、モデムが機能でき、さらにモデムがこのプロファイルのための接続パネル詳細フォームに表示されます。選択された国はダイアル接頭辞（訳者注: 原文は dialing prefix -- 市外局番や国番号のこと）とモデム リセット文字列を制御します。kCncParamCountryIndex パラメータはこのリストで選択される国を指定します。 |
| データ バッファは null で終了する文字列をまとめたブロックを保持します。各文字列は国名を保持します。データ バッファの最初 16 ビット（UInt16 値）はブロックの中にどれくらいの文字列があるかを知らせます。SysFormPointerArrayToStrings()|Palm OS Programmer's API Reference/54 を使ってデータ バッファを文字列の配列に変換することができます。 | ||
| このパラメータ値のサイズは可変なので、まず正確なサイズを取得するために NULL データ ポインタと一緒に CncProfileSettingGet() を呼び出す必要があります。 | ||
| kCncParamIntlModemResetStringList | バッファ | モデム プロファイルのための、あり得るリセット文字列を保持するデータ バッファ。kCncParamCountryIndex パラメータはこのリストからどのリセット文字列が使用されるかを指定します。実際に使用される文字列は kCncParamResetString パラメータに保存されます。 |
| データ バッファは、null で終了する文字列を一まとめにしたブロックを保持します。各文字列はリセット文字列を保持します、データ バッファの最初の 16 ビット（UInt16 値）はブロックの中にいくつの文字列があるのかを知らせます。SysFormPointerArrayToStrings()|Palm OS Programmer's API Referece/54 を使ってデータ バッファを文字列の配列に変換することができます。 | ||
| このパラメータは可変サイズなので、まず NULL データ ポインタと一緒に CncProfileSettingGet() を呼び出して正確なサイズを取得しなければなりません。 | ||
| kCncParamInvisible | システム フラグ | true の場合、プロファイルはユーザから隠されます。false の場合、プロファイルは可視です。このパラメータは現在使用されません。 |
| kCncParamLocked | システム フラグ | true の場合、プロファイルはロックされ、ユーザは編集できません。false の場合、プロファイルは編集可能です。このパラメータは、電話プロファイルなどのプロファイルによってセットすることができ、サード パーティーのユーティリティで作成することができます。 |
| kCncParamName | 文字列 | プロファイルの名前。 |
| kCncParamNoDetails | システム フラグ | true の場合、プロファイルの詳細は表示されるべきではありません。false の場合、表示させることが可能です。プロファイルの詳細は接続パネルの詳細フォームに現れるパラメータです。 |
| kCncParamNonEditable | システム フラグ | true の場合、接続パネルの編集フォームはこのプロファイルのために表示を抑制されるべきです。false の場合、編集フォームを表示させることが可能です。 |
| このパラメータは、kCncParamLocked や kCncParamReadOnly とは、ユーザが編集ボタンをタップした場合にアラートを表示させる点が異なります。他のパラメータは編集フォームが表示されるのを許可しますが、変更することは許可しません。また、編集不可のプロファイルを削除することは可能ですが、Read-only またはロックされたプロファイルを削除することはできません。 | ||
| kCncParamPort | UInt32 | 論理的、物理的、または仮想のポート識別子。追加情報は、「シリアル マネージャ」の「ポート定数」を参照してください。 |
| kCncParamReadOnly | システム フラグ | true の場合、プロファイルは Read-only で編集できません。false の場合、編集できます。このパラメータは単に Palm OS にプリ-インストールされるプロファイルによって使用されることを意図したものです。 |
| kCncParamResetString | 文字列 | モデムと電話プロファイルのためのリセット文字列。モデム プロファイルのためにはこの値は kCncParamIntlModemResetStringList の中の文字列の 1 つになります。 |
| kCncParamSerialPortFlags | UInt32 | 電話プロファイルのためのさまざまなシリアル ポート ハードウェア設定に関係するビット フラグ。追加情報は、「シリアル設定定数」を参照してください。 |
| kCncParamSystemFlags | UInt32 | すべてのシステム フラグを表しているビット フラグ。現在のところ、0 から 4 のビットが意味を持ちます。これらはそれぞれ、Read-only ビット、不可視ビット、編集不可ビット、詳細無しビット、ロック ビットに対応します。 |
| kCncParamTimeOut | UInt32 | CTS が不成立でハードウェア フロー制御がオンのときの応答待ち時間（ミリ秒）。 |
| kCncParamVersion | UInt8 | このプロファイルが作成した接続マネージャ API のバージョン。現在のバージョン番号は kCncProfileVersion。 |
| kCncParamVolume | UInt16 | モデム プロファイルのためのモデム ボリューム。 |
互換性
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、定義されます。
Phone Profile Parameters ^TOP^
目的
接続マネージャは以下の定数を、電話のためのプリ-インストールされた接続プロファイルの中の各パラメータを表すために、定義します。また、適用されるかもしれない他のパラメータ定数については、General Profile Parameters と GPRS Profile Parameters を参照してください。
宣言されている場所
ConnectionMgr.h
定数
- #define kCncParamReceiveTimeOut CncDefineParamID( kCncParamOSRange , kCncParamUInt32, 14 )
- 電話からの応答の待ち時間であるミリ秒数を保持している UInt32。このタイム-アウト値は、ネットワークにアクセスする必要の無い電話関数（例えば、TelNwkGetSelectedNetwork()|Palm OS Programmer's API Reference/75）によって使用されます。
- #define kCncParamTTCreator CncDefineParamID( kCncParamOSRange, kCncParamUInt32, 91 )
- 電話ドライバによって使用される電話タスクの作成者 ID を保持している UInt32。
- #define kCncParamTTType CncDefineParamID( kCncParamOSRange, kCncParamUInt32, 90 )
- 電話ドライバによって使用される電話タスクのデータベース タイプを保持している UInt32。
- #define kCncParam_GSM_BearerServices CncDefineParamID(kCncParamOSRange, kCncParamUInt8, 211 )
- #define kCncParam_GSM_ConnectionElement CncDefineParamID(kCncParamOSRange, kCncParamUInt8, 212 )
- #define kCncParam_GSM_Speed CncDefineParamID(kCncParamOSRange, kCncParamUInt8, 210 )
- #define kCncParam_PSDCreator CncDefineParamID( kCncParamOSRange, kCncParamUInt32, 93 )
- 電話ドライバの作成者 ID を保持している UInt32。
- #define kCncParam_PSDParameterBuffer CncDefineParamID(kCncParamOSRange, kCncParamBuffer, 100 )
- 電話ドライバが保存しなければならないすべての必要なデータを保持しているデータ バッファ。通常、このパラメータは接続パネルの詳細フォームを使ってセットされるデータを保持します。
- #define kCncParam_PSDType CncDefineParamID(kCncParamOSRange, kCncParamUInt32, 94 )
- 電話ドライバのためのデータベース タイプを保持している UInt32。
GPRS Profile Parameters ^TOP^
目的
接続マネージャは以下の定数を、GPRS ネットワークのためのプリ-インストールされた接続プロファイルの中の各パラメータを表すために、定義します。また、適用されるかもしれない他のパラメータ定数については、General Profile Parameters と Phone Profile Parameters を参照してください。
宣言されている場所
ConnectionMgr.h
定数
- #define kCncParam_GPRS_APNName CncDefineParamID(kCncParamOSRange, kCncParamString, 200 )
- GPRS アクセス ポイント名（APN）を保持している文字列。
- #define kCncParam_GPRS_DataCompression CncDefineParamID(kCncParamOSRange, kCncParamUInt8, 202 )
- データ圧縮を示す UInt8 に保存されたブール値。
- #define kCncParam_GPRS_QOS_Delay CncDefineParamID(kCncParamOSRange, kCncParamUInt8, 204 )
- GPRS サービスの品質遅れ値を保持している UInt8。
- #define kCncParam_GPRS_QOS_Mean CncDefineParamID(kCncParamOSRange, kCncParamUInt8, 207 )
- GPRS サービスの品質の平均スループットを保持している UInt8。
- #define kCncParam_GPRS_QOS_Peak CncDefineParamID(kCncParamOSRange, kCncParamUInt8, 206 )
- GPRS サービスの品質のピーク スループットを保持している UInt8。
- #define kCncParam_GPRS_QOS_Precedence CncDefineParamID(kCncParamOSRange, kCncParamUInt8, 203 )
- GPRS サービスの品質の先行値を保持している UInt8。
- {{span style='color:blue;font-family:monospace;',""#define kCncParam_GPRS_QOS_Reliability CncDefineParamID(kCncParamOSRange, kCncParamUInt8, 205 )""}}
- GPRS サービスの品質の信頼性の値を保持している UInt8。
Profile Parameter Sizes ^TOP^
サイズ定数は General Profile Parameters で説明されているあらかじめ定義された各パラメータのサイズを指定します。以下に示す表はパラメータ名、その値のサイズ、サイズを決めるサイズ定数をリストしています。これらのサイズ定数は CncProfileSettingGet() や CncProfileSettingSet() に渡すのに適しています。
宣言されている場所
ConnectionMgr.h
| プロファイル パラメータ名 | サイズ | サイズ定数 |
|---|---|---|
| kCncParamBaud | 32 | kCncParamBaudSize |
| kCncParamBluetoothDeviceAddr | 8 | kCncParamBluetoothDeviceAddrSize |
| kCncParamBluetoothDeviceName | 249 | kCncParamBluetoothDeviceNameMaxSize |
| kCncParamCountryIndex | 16 | kCncParamCountryIndexSize |
| kCncParamDeviceKind | 16 | kCncParamDeviceKindSize |
| kCncParamDialingMode | 8 | kCncParamDialingModeSize |
| kCncParamFlowControl | 16 | kCncParamFlowControlSize |
| kCncParamInitString | 81 | kCncParamInitStringMaxSize |
| 81 | kCncParamInitStringMaxSize | |
| kCncParamInvisible | 8 | kCncParamInvisibleSize |
| kCncParamLocked | 8 | kCncParamLockedSize |
| kCncParamName | 22 | kCncParamNameMaxSize |
| 22 | kCncProfileNameSize | |
| kCncParamNoDetails | 8 | kCncParamNoDetailsSize |
| kCncParamNonEditable | 8 | kCncParamNonEditableSize |
| kCncParamPort | 32 | kCncParamPortSize |
| kCncParam_PSDCreator | 32 | kCncParam_PSDCreatorSize |
| kCncParam_PSDName | 32 | kCncParam_PSDNameSize |
| kCncParam_PSDType | 32 | kCncParam_PSDTypeSize |
| kCncParamReadOnly | 8 | kCncParamReadOnlySize |
| kCncParamReceiveTimeOut | 32 | kCncParamReceiveTimeOutSize |
| kCncParamResetString | 81 | kCncParam_PSDNameSize |
| 8 | kCncProfileClassicResetStringSize | |
| 81 | kCncProfileUsualResetStringSize | |
| kCncParamSystemFlags | 32 | kCncParamSystemFlagsSize |
| kCncParamTimeOut | 32 | kCncParamTimeOutSize |
| kCncParamTTCreator | 32 | kCncParamTTCreatorSize |
| kCncParamTTType | 32 | kCncParamTTTypeSize |
| kCncParamVersion | 8 | kCncParamVersionSize |
| kCncParamVolume | 16 | kCncParamVolumeSize |
| kCncParam_GPRS_APNNam | kCncParam_GPRS_APNNameMaxSize（この値は、APN 名文字列が持つかもしれない最大のサイズです。） | |
| kCncParam_GPRS_DataCompression | 8 | kCncParam_GPRS_DataCompressionSize |
| kCncParam_GPRS_HeaderCompression | 8 | kCncParam_GPRS_HeaderCompressionSize |
| kCncParam_GPRS_QOS_Delay | 8 | kCncParam_GPRS_QOS_DelaySize |
| kCncParam_GPRS_QOS_Mean | 8 | kCncParam_GPRS_QOS_MeanSize |
| kCncParam_GPRS_QOS_Peak | 8 | kCncParam_GPRS_QOS_PeakSize |
| kCncParam_GPRS_QOS_Precedence | 8 | kCncParam_GPRS_QOS_PrecedenceSize |
| kCncParam_GPRS_QOS_Reliability | 8 | kCncParam_GPRS_QOS_ReliabilitySize |
| kCncParam_GSM_BearerServices | 8 | kCncParam_GSM_BearerServicesSize |
| kCncParam_GSM_ConnectionElement | 8 | kCncParam_GSM_BearerServicesSize |
| kCncParam_GSM_ConnectionElement | 8 | kCncParam_GSM_ConnectionElementSize |
| kCncParam_GSM_Speed | 8 | kCncParam_GSM_SpeedSize |
互換性
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、定義されます。
Profile Parameter Types ^TOP^
パラメータ タイプ定数は接続プロファイルの中のパラメータに保存される値のタイプを指定します。CncDefineParamID() を使って新しいパラメータを定義する場合、これらの定数の 1 つを使ってパラメータが保存するデータのタイプを指定しなければなりません。マクロ CncGetParamType() がプロファイルの中のいずれかのパラメータのためのこの情報を返すことができます。
宣言されている場所
ConnectionMgr.h
定数
- #define kCncParamBuffer CncDefineParameterType(kCncParamVariableLen, 2)
- データの一般的なブロック
- #define kCncParamString CncDefineParameterType(kCncParamVariableLen, 1)
- 文字列パラメータ
- #define kCncParamSystemFlag CncDefineParameterType(kCncParamFixedLen, 0)
- システム フラグ パラメータ。接続マネージャは最大 32個のシステム フラグを保存することができます。フラグは 1 つのビットの中に保存され UInt8 値として返されます。システム フラグ ワード全体は、CncProfileSettingGet() に kCncParamSystemFlagsを渡した場合に、返されます。
- #define kCncParamUInt16 CncDefineParameterType(kCncParamFixedLen, 2)
- UInt16 パラメータ
- #define kCncParamUInt32 CncDefineParameterType(kCncParamFixedLen, 3)
- UInt32 パラメータ
- #define kCncParamUInt8 CncDefineParameterType(kCncParamFixedLen, 1)
- UInt8 パラメータ
互換性
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、定義されます。
Device Kinds ^TOP^
目的
デバイス種類の定数は行われる接続のタイプを指定します。接続のタイプを、CncProfileSettingSet() を使って kCncParamDeviceKind の値を定義することによって、指定します。
宣言されている場所
ConnectionMgr.h
定数
- #define kCncDeviceKindGPRS 4
- GPRS ネットワークへの接続
- #define kCncDeviceKindGSM 5
- GSM 電話への接続
- #define kCncDeviceKindLocalNetwork 3
- LAN への接続
- #define kCncDeviceKindModem 1
- モデムへの接続
- #define kCncDeviceKindPhone 2
- 電話への接続
- #define kCncDeviceKindSerial 0
- シリアル ポートを通しての接続
互換性
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、定義されます。
接続 マネージャ関数 ^TOP^
CncAddProfile 関数 ^TOP^
目的
接続マネージャにプロファイルを追加します。
宣言されている場所
ConnectionMgr.h
Prototype
Err CncAddProfile ( Char *name, UInt32 port, UInt32 baud, UInt16 volume, UInt16 handShake, const Char *initString, const Char *resetString, Boolean isModem, Boolean isPulse )
パラメータ
- ←→ name
- 追加するプロファイル名へのポインタ。名前がすでに接続パネルにある場合、重複番号が追加されます。追加された名前はここに返されます。
- → port
- プロファイルによって使用されるポート識別子。追加情報については、Palm OS Programmer's Companion, vol. II 「通信」のポートの指定 を参照してください。
- → baud
- プロファイルによって使用されるボー レート。
- → volume
- デバイスのためのボリューム設定（モデムのみ）
- → handShake
- フロー制御設定（ハードウェア ハンドシェイク）。0 は自動（2400 ボーを超えるスピードでオン）を指定し、1 は常にオンを指定し、2 は常にオフを指定します。
- → initString
- モデムによって使用される初期化文字列へのポインタ（モデムのみ）。
- → resetString
- モデムによって使用されるリセット文字列へのポインタ（モデムのみ）。
- → isModem
- モデム接続の場合 true。直接の場合 false。
- → isPulse
- パルス ダイアルの場合 true。タッチ トーンの場合 false。
返り値
- errNone
- エラー無し
- cncErrAddProfileFailed
- 追加操作が失敗
- cncErrProfileListFull
- プロファイル リストが満杯のため、追加操作が失敗
- cncErrConDBNotFound
- 接続データベースが見つからない
コメント
接続マネージャのすべてのプロファイルは固有の名前を持たなくてはなりません。指定した名前がすでに使用されている場合、接続マネージャは名前の最後に重複番号を追加しようと試みます。
接続マネージャによって維持されるプロファイルの数には限度があります。限度を超えてプロファイルの追加をした場合、エラーが返され、プロファイルは追加されません。
ある特定のフィールドを必要としないプロファイルは、そのフィールドの値として NULL を渡すかもしれません。
互換性
New Serial Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、実装されます。
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合、この関数を使用する代わりに CncProfileCreate() を使用します。CncAddProfile の下位互換はまだサポートされています。Palm OS 4.0 以降では、定義できるプロファイルの最大数はかなり増加しました。
例
AddMyProfile() { Char *myConNameP; Err err; myConNameP = MemPtrNew(cncProfileNameSize); StrCopy(myConNameP, "Foobar"); err = CncAddProfile(myConNameP, 'u328', 57600, 0, 0, "AT&FX4", 0, true, false); MemPtrFree(myConNameP); }
CncDefineParamID マクロ ^TOP^
目的
パラメータ ID を作成し、返します。
宣言されている場所
ConnectionMgr.h
Prototype
#define CncDefineParamID ( parameterRange, parameterType, parameterID )
パラメータ
- → parameterRange
- このパラメータが OS によって定義されたものではないことを示すために kCncParamThirdPartiesRange を使用します。
- → parameterType
- パラメータに保存される値のタイプ。とり得る値のリストについては、Profile Parameter Types を参照してください。
- → parameterID
- 0 から 1023 までの固有の値。この値はパラメータを定義しようとしているプロファイル内で固有でなければなりません。
kCncParamSystemFlag の parameterType を使用している場合、どのシステム フラグ ビットがセットされるのかを指定するために 0 から 31 までの値を指定してください。
- 0 から 1023 までの固有の値。この値はパラメータを定義しようとしているプロファイル内で固有でなければなりません。
返り値
パラメータ ID を UInt16 値として返します。
コメント
接続プロファイルを定義していて、そのプロファイルの中に定義する必要のあるパラメータがある場合にのみ、このマクロを使用します。パラメータ ID はすぐに、接続マネージャ プロファイル データベースのパラメータ値に先行します。データベースのフォーマットの仕方にはいくつかあるため、パラメータ ID は接続マネージャに後に続く一連のバイトをどのように解釈すべきか知らせる必要があります。この理由から、パラメータ ID の上位ビットは、値のタイプと値がシステムによって定義されるのか、それともサード パーティによって定義されるのかについての情報を含みます。
互換性
このフォーマットのパラメータ ID は、4.0 New Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、使用されます。
参照
CncProfileSettingSet(), CncProfileSettingGet()
CncDeleteProfile 関数 ^TOP^
目的
プロファイルを接続マネージャから削除します。
宣言されている場所
ConnectionMgr.h
Prototype
Err CncDeleteProfile ( const Char *name )
パラメータ
- → name
- 削除されるプロファイルの名前へのポインタ
返り値
- errNone
- エラーはありません。
- cncErrProfileReadOnly
- プロファイルは Read-only であるため、削除できませんでした。
- cncErrProfileNotFound
- プロファイルが見つかりませんでした。
- cncErrConDBNotFound
- 接続データベースが見つかりません。
コメント
ユニット上にプリ-インストールされたプロファイルは Read-only で、削除することはできません。
互換性
New Serial Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、定義されます。
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合、この関数の代わりに CncProfileDelete() を使用してください。
CncGetParamType マクロ ^TOP^
目的
パラメータ ID の一部であるパラメータ タイプを返します。
宣言されている場所
ConnectionMgr.h
Prototype
#define CncGetParamType ( parameterID )
パラメータ
- → parameterID
- パラメータ ID を保持する UInt16
返り値
ビット 11 から 14 までが Profile Parameter Types の中の値の 1 つを保持し、他のビットはクリアされている UInt16 を返します。
互換性
このフォーマットのパラメータ ID は、4.0 New Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、使用されます。
参照
CncProfileSettingSet(), CncProfileSettingGet()
CncGetProfileInfo 関数 ^TOP^
目的
プロファイルの設定を返します。
宣言されている場所
ConnectionMgr.h
Prototype
Err CncGetProfileInfo ( Char *name, UInt32 *port, UInt32 *baud, UInt16 *volume, UInt16 *handShake, Char *initString, Char *resetString, Boolean *isModem, Boolean *isPulse )
パラメータ
- → name
- 返されるプロファイルの名前へのポインタ。このパラメータに NULL を渡すと、この関数は現在接続パネルで選択されているプロファイルの設定を返します。
- ← port
- プロファイルが使用しているポート識別子へのポインタ
- ← baud
- このプロファイルにセットされているボー レートへのポインタ
- ← volume
- デバイスのボリュームへのポインタ（モデムに対してのみ適用されます）
- ← handShake
- フロー制御設定（ハードウェア ハンドシェイク）へのポインタ。0 は自動（2400 ボーを超えるスピードでオン）を示し、1 は常にオン、2 は常にオフを示します。
- ← initString
- デバイスのための初期化文字列へのポインタ（モデムに対してのみ適用されます）
- ← resetString
- デバイスのためのリセット文字列へのポインタ（モデムに対してのみ適用されます）
- ← isModem
- ブール値へのポインタ: true はモデムを通しての接続、false は直接接続を意味します。
- ← isPulse
- ブール値へのポインタ: true はパルス ダイアル、false はタッチ トーンを意味します。
返り値
- errNone
- エラーはありません。
- cncErrGetProfileFailed
- プロファイル取得操作が失敗しました。プロファイルはそこにあるかもしれませんし、ないかもしれません。
- cncErrProfileNotFound
- プロファイルが見つかりませんでした。
- cncErrConDBNotFound
- 接続データベースが見つかりません。
コメント
取得する必要のない情報がある場合、1 つ以上のパラメータに NULL をセットするかもしれません。
互換性
New Serial Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、実装されます。
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合、この関数を使用する代わりに General Profile Parameters の 1 つと一緒に CncProfileSettingGet() を使用してください。
例
{ UInt32 portID, baud; UInt16 openPort; // get port id err = CncGetProfileInfo("Direct Serial", &portID, &baud, 0, 0, 0, 0, 0, 0); if(!err) { // open the port SrmOpen(portID, baud, &openPort); } }{{span_end}]
CncGetProfileList 関数 ^TOP^
目的
接続マネージャを通して使用可能なプロファイルのリストを返します。
宣言されている場所
ConnectionMgr.h
Prototype
Err CncGetProfileList ( Char ***nameListPPP, UInt16 *countP )
パラメータ
- ← nameListPPP
- プロファイル名のリストへのポインタへのポインタ
- ← countP
- プロファイル名の番号へのポインタ
返り値
- errNone
- エラーはありません。
- cncErrGetProfileListFailed
- プロファイル リストが見つかりませんでした。
- cncErrConDBNotFound
- 接続データベースが見つかりません。
コメント
リストの割り当ては接続マネージャによってハンドルされます。割り当て解除は呼び出したアプリケーションに責任があります。リストの中で最後に "-Current-" が追加されたプロファイルは、そのプロファイルが現在接続パネルで選択されているプロファイルであることを表します。
例
//Declared globally Char **globalProfileList; ListType *listP; UInt16 globalProfileCount; void SetConnectionList() { //Get the list from the Connection Manager err = CncGetProfileList(&globalProfileList, &globalProfileCount); //Set the UI list LstSetListChoices(listP, globalProfileList, globalProfileCount); } void StopApplication() { UInt16 i; //Deallocate the connection list For(i = 0; i < globalProfileCount; i++) MemPtrFree(globalProfileList[ i ]); MemPtrFree(globalProfileList); }
CncGetSystemFlagBitnum マクロ ^TOP^
目的
システム フラグ パラメータを一意に識別する数を返します。
宣言されている場所
ConnectionMgr.h
Prototype
#define CncGetSystemFlagBitnum ( parameterID )
パラメータ
- → parameterID
- パラメータ ID を保持している UInt16
返り値
システム フラグ パラメータの ID を返します。この値は 0 から 31 までの値です。
参照
CncProfileSettingSet(), CncProfileSettingGet()
CncGetTrueParamID マクロ ^TOP^
目的
パラメータを一意に識別するパラメータ ID の一部を返します。
宣言されている場所
ConnectionMgr.h
Prototype
#define CncGetTrueParamID ( parameterID )
パラメータ
- → parameterID
- パラメータ ID を保持している UInt16
返り値
単にパラメータ ID を保持している UInt16 を返します。パラメータ タイプとアドレス空間を指定する上位ビットはクリアされます。
互換性
このフォーマットのパラメータ ID は、New Serial Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、使用されます。
参照
CncProfileSettingSet(), CncProfileSettingGet()
CncIsFixedLengthParamType マクロ ^TOP^
目的
パラメータ値が固定長か可変長かを識別します。
宣言されている場所
ConnectionMgr.h
Prototype
#define CncIsFixedLengthParamType ( parameterID )
パラメータ
- → parameterID
- パラメータ ID を保持している UInt16
返り値
パラメータが UInt32 などの固定長パラメータ タイプである場合 true を返します。可変長タイプである場合 false を返します。
互換性
このフォーマットのパラメータ ID は、New Serial Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、使用されます。
参照
CncProfileSettingSet(), CncProfileSettingGet()
CncIsSystemFlags マクロ ^TOP^
目的
パラメータ値がシステム フラグかどうかを返します。
宣言されている場所
ConnectionMgr.h
Prototype
#define CncIsSystemFlags ( parameterID )
パラメータ
- → parameterID
- パラメータ ID を保持している UInt16
返り値
パラメータ タイプがシステム フラグである場合 true を返します。そうでない場合 false を返します。
互換性
このフォーマットのパラメータ ID は、New Serial Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、使用されます。
参照
CncProfileSettingSet(), CncProfileSettingGet()
CncIsSystemRange マクロ ^TOP^
目的
パラメータがシステムによって定義されたのか、サード パーティによって定義されたのかを識別します。
宣言されている場所
ConnectionMgr.h
Prototype
#define CncIsSystemRange ( parameterID )
パラメータ
- → parameterID
- パラメータ ID を保持している UInt16
返り値
パラメータ ID が Palm OS によって定義されている場合 true を返します。サード パーティによって定義されている場合 false を返します。
互換性
このフォーマットのパラメータ ID は、New Serial Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、使用されます。
参照
CncProfileSettingSet(), CncProfileSettingGet()
CncIsThirdPartiesRange マクロ ^TOP^
目的
パラメータがサード パーティによって定義されたのかを識別します。
宣言されている場所
ConnectionMgr.h
Prototype
#define CncIsThirdPartiesRange ( parameterID )
パラメータ
- → parameterID
- パラメータ ID を保持している UInt16
返り値
パラメータ ID が サード パーティによって定義されている場合 true を返します。Palm OS によって定義されている場合 false を返します。
互換性
このフォーマットのパラメータ ID は、New Serial Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、使用されます。
参照
CncProfileSettingSet(), CncProfileSettingGet()
CncIsVariableLengthParamType マクロ ^TOP^
目的
パラメータ値が可変長タイプかどうかを返します。
宣言されている場所
ConnectionMgr.h
Prototype
#define CncIsVariableLengthParamType ( parameterID )
パラメータ
- → parameterID
- パラメータ ID を保持している UInt16
返り値
パラメータが可変長文字列またはバッファの場合 true を返します。パラメータが整数などの固定長タイプを保持する場合 false を返します。
互換性
このフォーマットのパラメータ ID は、New Serial Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、使用されます。
参照
CncProfileSettingSet(), CncProfileSettingGet()
CncProfileCloseDB 関数 ^TOP^
目的
接続マネージャ プロファイル データベースをクローズします。
宣言されている場所
ConnectionMgr.h
Prototype
Err CncProfileCloseDB ( void )
パラメータ
ありません。
返り値
- errNone
- エラーはありません。
- kCncErrDBAccessFailed
- データベースをクローズすることができなかった、または、参照カウント エラーです。
コメント
いくつかの接続マネージャ呼び出しを作成している場合、最適化として CncProfileOpenDB() と CncProfileCloseDB を使用します。すべての接続マネージャ呼び出しは、開始時にプロファイル データベースをオープンし、終了時にクローズします。接続マネージャは、データベースがオープンされているかどうかを知らせる参照カウンタを維持します。他の接続マネージャを呼び出す前に CncProfileOpenDB を呼び出した場合、次に呼び出された接続マネージャはそのデータベースをオープンしたり、クローズすることはありません。これは作成するアプリケーションの、プロファイル データベースをオープンまたはクローズするときの、オーバヘッドを減らします。
互換性
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、実装されます。
CncProfileCount 関数 ^TOP^
目的
接続マネージャ プロファイル データベースの中で現在定義されている接続プロファイルの番号を返します。
宣言されている場所
ConnectionMgr.h
Prototype
Err CncProfileCount ( UInt16 *profilesCountP )
パラメータ
- ← profilesCountP
- プロファイルの番号
返り値
- errNone
- エラーはありません。
- kCncErrDBAccessFailed
- プロファイル データベースをオープンすることができませんでした。
互換性
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、実装されます。
参照
CncProfileCreate 関数 ^TOP^
目的
プロファイル レコードを接続マネージャ プロファイル データベースに追加します。
宣言されている場所
ConnectionMgr.h
Prototype
Err CncProfileCreate ( CncProfileID *profileIdP )
パラメータ
- ← profileIdP
- 返り時に、新しいプロファイルの固有の ID を保持します。
返り値
- errNone
- エラーはありません。
- kCncErrDBAccessFailed
- プロファイル データベースをオープンすることができませんでした。
- a Data Manager error
- 新しいレコードを作製することができませんでした。
コメント
この関数は新しい空のレコードを接続マネージャ プロファイル データベースの中に作成します。プロファイルを実装するために、CncProfileSettingSet() を使ってプロファイル名を含むパラメータ値をセットします。作成したプロファイルに固有の情報を保存する場合、CncDefineParamID() を使用してください。
互換性
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、実装されます。
参照
CncAddProfile(), CncProfileDelete()
CncProfileDelete 関数 ^TOP^
目的
プロファイルを削除します。
宣言されている場所
ConnectionMgr.h
Prototype
Err CncProfileDelete ( CncProfileID profileId )
パラメータ
- profileId
- 削除するプロファイルの ID
返り値
- errNone
- エラーはありません。
- kCncErrDBAccessFailed
- プロファイル データベースをオープンすることができませんでした。または、レコードを削除することができませんでした。
- kCncErrProfileParamNotFound
- データベースは指定された ID を持つプロファイルを保持していません。
コメント
ユニット上にプリ-インストールされているプロファイルは Read-only で削除することはできません。
互換性
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、実装されます。
参照
CncDeleteProfile(), CncProfileCreate()
CncProfileGetCurrent 関数 ^TOP^
目的
接続パネルの中で現在選択されているプロファイルの ID を返します。
宣言されている場所
ConnectionMgr.h
Prototype
Err CncProfileGetCurrent( CncProfileID *profileIdP )
パラメータ
- ← profileId
- 現在選択されているプロファイルの ID
返り値
- errNone
- エラーはありません。
- kCncErrDBAccessFailed
- プロファイル データベースをオープンすることができませんでした。
互換性
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、実装されます。
参照
CncProfileGetIDFromIndex(), CncProfileGetIDFromName(), CncProfileGetIndex(), CncProfileSetCurrent()
CncProfileGetIDFromIndex 関数 ^TOP^
目的
与えられた接続マネージャ プロファイル データベースへのインデックスを持つプロファイル ID を返します。
宣言されている場所
ConnectionMgr.h
Prototype
Err CncProfileGetIDFromIndex ( UInt16 index, CncProfileID *profileIdP )
パラメータ
- → index
- 接続マネージャ プロファイルのインデックス
- ← profileIdP
- 接続マネージャ プロファイルの ID
返り値
- errNone
- エラーはありません。
- kCncErrDBAccessFailed
- プロファイル データベースをオープンすることができませんでした。
- kCncErrProfileParamNotFound
- 指定されたインデックスを持つプロファイルはありません。
互換性
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、実装されます。
参照
{[goto CncProfileGetIDFromName,CncProfileGetIDFromName()}}, {[goto CncProfileGetCurrent,CncProfileGetCurrent()}}, CncProfileGetIndex()
CncProfileGetIDFromName 関数 ^TOP^
目的
与えられた名前を持つプロファイル ID を返します。
宣言されている場所
ConnectionMgr.h
Prototype
Err CncProfileGetIDFromName( const Char *profileNameP, CncProfileID *profileIdP )
パラメータ
- → profileNameP
- プロファイルの名前。名前は接続パネルの中のポップアップ リストの中に表示されます。文字列 "-Current-" を渡した場合、この関数は現在選択されているプロファイルの ID を返します。
- ← profileIdP
- プロファイルの ID
返り値
- errNone
- エラーはありません。
- kCncErrDBAccessFailed
- プロファイル データベースをオープンすることができませんでした。
- kCncErrProfileParamNotFound
- 指定された名前を持つプロファイルはありません。
互換性
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、実装されます。
参照
{[goto CncProfileGetCurrent,CncProfileGetCurrent()}}, {[goto CncProfileGetIDFromIndex,CncProfileGetIDFromIndex()}}, CncProfileGetIndex()
CncProfileGetIndex 関数 ^TOP^
目的
与えられた ID を持つプロファイルのインデックスを返します。
宣言されている場所
ConnectionMgr.h
Prototype
Err CncProfileGetIndex ( CncProfileID profileId, UInt16 *indexP )
パラメータ
- → profileId
- プロファイル ID
- ← indexP
- 接続マネージャ プロファイル データベースの中のプロファイルのレコードのインデックス
返り値
- errNone
- エラーはありません。
- kCncErrDBAccessFailed
- プロファイル データベースをオープンすることができませんでした。
- kCncErrProfileParamNotFound
- 指定された ID を持つプロファイルはありません。
互換性
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、実装されます。
参照
CncProfileOpenDB 関数 ^TOP^
目的
接続マネージャ プロファイル データベースをオープンします。
宣言されている場所
ConnectionMgr.h
Prototype
Err CncProfileOpenDB ( void )
パラメータ
ありません。
返り値
- errNone
- エラーはありません。
- kCncErrDBAccessFailed
- プロファイル データベースをオープンすることができませんでした。
コメント
いくつかの接続マネージャ呼び出しを作成している場合、最適化として CncProfileOpenDB と CncProfileCloseDB() を使用します。すべての接続マネージャ呼び出しは、開始時にプロファイル データベースをオープンし、終了時にクローズします。接続マネージャは、データベースがオープンされているかどうかを知らせる参照カウンタを維持します。他の接続マネージャを呼び出す前に CncProfileOpenDB を呼び出した場合、次に呼び出された接続マネージャはそのデータベースをオープンしたり、クローズすることはありません。これは作成するアプリケーションの、プロファイル データベースをオープンまたはクローズするときの、オーバヘッドを減らします。
互換性
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、実装されます。
CncProfileSetCurrent 関数 ^TOP^
目的
現在の（訳者補足: 選択されている）プロファイルをセットします。
宣言されている場所
ConnectionMgr.h
Prototype
Err CncProfileSetCurrent ( CncProfileID profileId )
パラメータ
- → profileId
- 現在のプロファイルにされるプロファイルの ID。
返り値
- errNone
- エラーはありません。
- kCncErrDBAccessFailed
- プロファイル データベースをオープンすることができませんでした。
コメント
現在のプロファイルは次にネットワーク接続を試みるときに使用されるプロファイルです。
互換性
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、実装されます。
参照
CncProfileSettingGet 関数 ^TOP^
目的
接続マネージャ プロファイルの 1 つの中に保存されている値を取得します。
宣言されている場所
ConnectionMgr.h
Prototype
Err CncProfileSettingGet ( CncProfileID profileId, UInt16 paramId, void *paramBufferP, UInt16 *ioParamSizeP )
パラメータ
- → profileId
- パラメータ値を取得するプロファイルの ID。
- → paramId
- 取得するパラメータの ID。デバイス上にプリ-インストールされたプロファイルの中で使用されるパラメータのリストは、General Profile Parameters を参照してください。
- ← paramBufferP
- パラメータ値が書き込まれるバッファへのポインタ。パラメータが可変サイズの値に保存されている場合、paramBufferP に NULL を渡すことで必要なサイズを決定することができます。返り時に、ioParamSizeP（訳者注: 原文では paramSize だが誤りと思われる）が要求されるサイズを保持します。
- ←→ ioParamSizeP
- 入力時には、パラメータ値が書き込まれるバッファのサイズへのポインタです。出力時には、paramBufferP に書き込まれたバイト数へのポインタです。
返り値
- errNone
- エラーはありません。
- kCncErrDBAccessFailed
- プロファイル データベースをオープンすることができませんでした。
- kCncErrProfileGetParamFailed
- 接続マネージャはパラメータの値を取得するのに失敗しました。
- kCncErrProfileBadSystemFlagBitnum
- 定義されていないシステム フラグの値を取得しようとしました。
- kCncErrProfileBadParamSize
- paramBufferP バッファが小さすぎます。ioParamSizeP がバッファの正確なサイズを保持しています。
- kCncErrProfileParamNotFound
- 指定されたパラメータはプロファイルの中で定義されていません。
互換性
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、実装されます。
参照
CncProfileSettingSet(), CncGetProfileInfo()
CncProfileSettingSet 関数 ^TOP^
目的
指定されたプロファイルの中の 1 つの値をセットします。
宣言されている場所
ConnectionMgr.h
Prototype
Err CncProfileSettingSet ( CncProfileID iProfileId, UInt16 paramId, const void *paramBufferP, UInt16 paramSize )
パラメータ
- → profileId
- プロファイルの ID。
- → paramId
- パラメータの ID。プリ-インストールされたプロファイルの中で定義されたパラメータのリストは、General Profile Parameters を参照してください。
- → paramBufferP
- このパラメータにセットする値へのポインタ。
- → paramSize
- paramBufferP の中に渡されるバッファのサイズ。Profile Parameter Sizes を参照してください。
返り値
- errNone
- エラーはありません。
- kCncErrDBAccessFailed
- プロファイル データベースをオープンすることができませんでした。
- kCncErrProfileParamNotFound
- 指定された ID を持つプロファイルはありません。
- kCncErrProfileSetParamFailed
- 接続マネージャはパラメータの値をセットするのに失敗しました。
- kCncErrProfileBadParamSize
- paramBufferP バッファが小さすぎます。たいてい、指定されたサイズが、文字列パラメータの null 終端子をサイズに含めることを許可しないために起こります。
- kCncErrProfileParamNameHasChange
- プロファイル名をすでに使用されているプロファイル名にしようとしました。接続マネージャはプロファイル名の最後に重複番号を追加し、このエラーを返します。CncProfileSettingGet() を使って新しい名前を探すべきです。
互換性
Connection Manager Feature Set|Palm OS Programmer's API Referece/B が満たされる場合にのみ、実装されます。
参照
CncDefineParamID(), CncProfileSettingGet()
