- 追加された行はこのように表示されます。
- 削除された行は
このように表示されます。
{{div_begin}}
[[← 13 章に戻る|C/C++ Sync Suite Reference601/13]] [[↑トップへ|C/C++ Sync Suite Reference601]] [[15 章に進む →|C/C++ Sync Suite Reference601/15]]
{{div_end}}
{{div_begin style="margin-bottom:-10px"}}
!!!14 HotSync マネージャ API
{{div_end}}
{{div_begin "style='position:absolute;right:0px;font-size:70%;margin-right:15px;margin-top:15px;width:250px;'"}}
*{{goto HotSync Manager API Constants,HotSync マネージャ API 定数}}
**{{goto Connection Status Flags,接続ステータス フラグ}}
**{{goto HotSync Manager API Versions,HotSync マネージャ API バージョン}}
**{{goto HSConnectionType,HSConnectionType}}
**{{goto HsStatusType,HsStatusType}}
**{{goto Start Options,開始オプション}}
**{{goto Synchronization Status Flags,同期ステータス フラグ}}
*{{goto HotSync Manager API Functions,HotSync マネージャ API 関数}}
**{{goto HsCheckApiStatus,HsCheckApiStatus}}
**{{goto HsDisplayCustomDlg,HsDisplayCustomDlg}}
**{{goto HsDisplayFileLink,HsDisplayFileLink}}
**{{goto HsDisplayLog,HsDisplayLog}}
**{{goto HsDisplaySetupDlg,HsDisplaySetupDlg}}
**{{goto HsGetApiVersion,HsGetApiVersion}}
**{{goto HsGetCommStatus,HsGetCommStatus}}
**{{goto HsGetSyncStatus,HsGetSyncStatus}}
**{{goto HsRefreshConduitInfo,HsRefreshConduitInfo}}
**{{goto HsResetComm,HsResetComm}}
**{{goto HsSetAppStatus,HsSetAppStatus}}
**{{goto HsSetCommStatus,HsSetCommStatus}}
*{{goto HotSync Manager API Error Codes,HotSync マネージャ 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;'"}}
あなたのアプリケーションが HotSync マネージャを以下のように制御できるようにするために HotSync マネージャ API を使用します:
*HotSync マネージャを停止、開始、リスタート、リフレッシュします。
*コンジットをカスタマイズしたり、接続設定を変更したり、HotSync ログを表示するために HotSync マネージャ ダイアログを呼び出します。
*シリアル、モデム、赤外線通信、USB、ネットワーク接続に対する接続ステータス タイプをチェックまたはセットします。
*HotSync マネージャが待機状態と同期実行中のどちらであるかかをチェックします。
HotSync マネージャ API 関数は {{span style='color:blue;font-family:monospace;',HSAPI.dll}} の中で利用可能であり、{{span style='color:blue;font-family:monospace;',HSAPI.h}} で宣言されています。
この章は以下の節に分かれています:
*{{goto HotSync Manager API Constants,HotSync マネージャ API 定数}}
*{{goto HotSync Manager API Functions,HotSync マネージャ API 関数}}
*{{goto HotSync Manager API Error Codes,HotSync マネージャ API エラー コード}}
!!{{anchor HotSync Manager API Constants}}HotSync マネージャ API 定数 {{goto top,^TOP^}}
この節はあなたが HotSync マネージャ API 関数で使用する以下の列挙定数とプロセッサ定数のグループについて説明します。
,定数,説明
,"{{goto Connection Status Flags,接続ステータス フラグ}}",接続タイプが使用可能と使用不可のどちらであるかを示します。
,"{{goto HotSync Manager API Versions,HotSync マネージャ API バージョン}}","{{goto HsGetApiVersion,HsGetApiVersion()}} が返すことができる HotSync マネージャ API バージョン番号を定義します。"
,"{{goto HSConnectionType,HSConnectionType}}",HotSync マネージャがハンドヘルドとの間で作ることができる接続のタイプを定義します。
,"{{goto HsStatusType,HsStatusType}}","{{goto HsSetAppStatus,HsSetAppStatus()}} が実行できるアクションを指定します。"
,"{{goto Start Options,開始オプション}}","{{goto HsSetAppStatus,HsSetAppStatus()}} で HotSync マネージャ アプリケーションを開始するときのオプションを指定します。"
,"{{goto Synchronization Status Flags,同期ステータス フラグ}}",HotSync マネージャが HotSync を実行中かどうかを示します。
!{{anchor Connection Status Flags}}接続ステータス フラグ {{goto top,^TOP^}}
'''目的'''
接続タイプが使用可能と使用不可のどちらであるかを示します。
'''宣言されている場所'''
{{span style='color:blue;font-family:monospace;',HSAPI.h}}
'''定数'''
*{{span style='color:blue;font-family:monospace;',#define HSCONNECTION_DISABLED 0x00000000}}
**指定された接続タイプは使用不可です。
*{{span style='color:blue;font-family:monospace;',#define HSCONNECTION_ENABLED 0x00000001}}
**指定された接続タイプは使用可能です。
'''互換性'''
*HotSync マネージャ API バージョン: すべて
*Palm OS バージョン: すべて
'''参照'''
{{goto HsGetCommStatus,HsGetCommStatus()}}, {{goto HsSetCommStatus,HsSetCommStatus()}}
!{{anchor HotSync Manager API Versions}}HotSync マネージャ API バージョン {{goto top,^TOP^}}
'''目的'''
{{goto HsGetApiVersion,HsGetApiVersion()}} が返すことができる HotSync マネージャ API バージョン番号を定義します。
'''宣言されている場所'''
{{span style='color:blue;font-family:monospace;',HSAPI.h}}
'''定数'''
*{{span style='color:blue;font-family:monospace;',#define HS_API_VERSION_1 0x00010001}}
**HotSync マネージャ API バージョン 1 によって返される値です。
*{{span style='color:blue;font-family:monospace;',#define HS_API_VERSION_2 0x00010002}}
**HotSync マネージャ API バージョン 2 によって返される値です。
'''互換性'''
*HotSync マネージャ API バージョン: すべて
*Palm OS バージョン: すべて
'''参照'''
{{goto HsGetApiVersion,HsGetApiVersion()}}
!{{anchor HSConnectionType}}HSConnectionType 列挙体 {{goto top,^TOP^}}
'''目的'''
HotSync マネージャがハンドヘルドとの間で作ることができる接続のタイプを定義します。
'''宣言されている場所'''
{{span style='color:blue;font-family:monospace;',HSAPI.h}}
'''定数'''
*{{span style='color:blue;font-family:monospace;',CtSerialPort = 0}}
**ローカル (シリアル) 接続メソッド。
*{{span style='color:blue;font-family:monospace;',CtModemPort = 1}}
**モデム接続メソッド。
*{{span style='color:blue;font-family:monospace;',CtNetwork = 2}}
**ネットワーク接続メソッド。
*{{span style='color:blue;font-family:monospace;',CtIr = 3}}
**赤外線通信接続メソッド。
*{{span style='color:blue;font-family:monospace;',CtUSB = 4}}
**ローカル USB 接続メソッド。
*{{span style='color:blue;font-family:monospace;',CtReserved}}
**将来使用するために予約されています。
'''互換性'''
*HotSync マネージャ API バージョン: すべて
*Palm OS バージョン: すべて
'''参照'''
{{goto HsGetCommStatus,HsGetCommStatus()}}, {{goto HsSetCommStatus,HsSetCommStatus()}}
!{{anchor HsStatusType}}HsStatusType {{goto top,^TOP^}}
'''目的'''
{{goto HsSetAppStatus,HsSetAppStatus()}} が実行できるアクションを指定します。
'''宣言されている場所'''
{{span style='color:blue;font-family:monospace;',HSAPI.h}}
'''定数'''
*{{span style='color:blue;font-family:monospace;',HsCloseApp}}
**HotSync マネージャ アプリケーション (が実行中であれば) をクローズします。
*{{span style='color:blue;font-family:monospace;',HsStartApp}}
**HotSync マネージャ アプリケーション (がまだ実行中でなければ) を開始します。
*{{span style='color:blue;font-family:monospace;',HsRestart}}
**HotSync マネージャ アプリケーションをクローズしてリスタートします。
*{{span style='color:blue;font-family:monospace;',HsReserved}}
**将来使用するために予約されています。
'''互換性'''
*HotSync マネージャ API バージョン: すべて
*Palm OS バージョン: すべて
'''参照'''
{{goto HsSetAppStatus,HsSetAppStatus()}}
!{{anchor Start Options}}開始オプション {{goto top,^TOP^}}
'''目的'''
{{goto HsSetAppStatus,HsSetAppStatus()}} で HotSync マネージャ アプリケーションを開始するときのオプションを指定します。
'''宣言されている場所'''
{{span style='color:blue;font-family:monospace;',HSAPI.h}}
'''定数'''
*{{span style='color:blue;font-family:monospace;',#define HSFLAG_DEVICE_SYNC_CHECK 0x00010000}}
**HotSync マネージャを開始/ストップ同期モードで実行します。このモードでは、ハンドヘルドとの HotSync の最中に HotSync マネージャはコンジットを実行しません; 接続を検証するだけです。これはコマンド ラインから {{span style='color:blue;font-family:monospace;',-c}} オプションをつけて HotSync マネージャを開始するのと同じことです。
*{{span style='color:blue;font-family:monospace;',#define HSFLAG_INSPECT_CONDUIT 0x00001000}}
**HotSync マネージャを実行し、Conduit Inspector ユーティリティを起動します。これはコマンド ラインから {{span style='color:blue;font-family:monospace;',-ic}} オプションをつけて HotSync マネージャを開始するのと同じことです。Conduit Inspector についての更なる情報は、''Conduit Development Utilites Guide'' の [[第 6 章 「Conduit Inspector ユーティリティ」|Conduit Development Guide601/6]] を参照してください。この値は HotSync マネージャ API バージョン 2 以降でのみ定義されています。
*{{span style='color:blue;font-family:monospace;',#define HSFLAG_LOG_DEBUG_LEVEL_1 0x00000100}}
**HotSync マネージャをデバッグ ログ モード 1 で実行します。これはコマンド ラインから {{span style='color:blue;font-family:monospace;',-L1}} オプションをつけて HotSync マネージャを開始するのと同じことです。
*{{span style='color:blue;font-family:monospace;',#define HSFLAG_LOG_DEBUG_LEVEL_2 0x00000200}}
**HotSync マネージャをデバッグ ログ モード 2 で実行します。これはコマンド ラインから {{span style='color:blue;font-family:monospace;',-L2}} オプションをつけて HotSync マネージャを開始するのと同じことです。
*{{span style='color:blue;font-family:monospace;',#define HSFLAG_NONE 0x00000000}}
**フラグをセットしません。これはコマンド ラインからオプションをつけずに HotSync マネージャを開始するのと同じことです。
*{{span style='color:blue;font-family:monospace;',#define HSFLAG_RESTORE_REGISTRY 0x00000001}}
**失われたすべてのコンフィグレーション エントリをリストアします。これはコマンド ラインから {{span style='color:blue;font-family:monospace;',-r}} オプションをつけて HotSync マネージャを開始するのと同じことです。
*{{span style='color:blue;font-family:monospace;',#define HSFLAG_RESTORE_REGISTRY_DEFAULT 0x00000002}}
**コンフィグレーション エントリをデフォルトに戻します。これはコマンド ラインから {{span style='color:blue;font-family:monospace;',-d}} オプションをつけて HotSync マネージャを開始するのと同じことです。
*{{span style='color:blue;font-family:monospace;',#define HSFLAG_VERBOSE 0x00000010}}
**HotSync マネージャを verbose (多弁な) ログ モードで実行します。これはコマンド ラインから {{span style='color:blue;font-family:monospace;',-v}} オプションをつけて HotSync マネージャを開始するのと同じことです。
'''コメント'''
これらのオプションと HotSync マネージャ コマンド ライン オプションとの対応についての詳細は ''Conduit Development Utilities Guide'' の {{goto Using Command-line Options for HotSync Manager ,「HotSync マネージャに対するコマンド ライン オプションの使用」|Conduit Development Utilities Guide601/4}} を参照してください。
'''互換性'''
*HotSync マネージャ API バージョン: すべて、例外として {{span style='color:blue;font-family:monospace;',HSFLAG_INSPECT_CONDUIT}} はバージョン 2 以降に対してのみ定義されています。
*Palm OS バージョン: すべて
'''参照'''
{{goto HsSetAppStatus,HsSetAppStatus()}}
!{{anchor Synchronization Status Flags}}同期ステータス フラグ {{goto top,^TOP^}}
'''目的'''
HotSync マネージャが HotSync を実行中かどうかを示します。
'''宣言されている場所'''
{{span style='color:blue;font-family:monospace;',HSAPI.h}}
'''定数'''
*{{span style='color:blue;font-family:monospace;',#define HOTSYNC_STATUS_IDLE 0l}}
**HotSync マネージャは HotSync を実行中ではありません。
*{{span style='color:blue;font-family:monospace;',#define HOTSYNC_STATUS_SYNCING 1l}}
**HotSync マネージャは HotSync を実行中です。
'''互換性'''
*HotSync マネージャ API バージョン: すべて
*Palm OS バージョン: すべて
'''参照'''
{{goto HsGetSyncStatus,HsGetSyncStatus()}}
!!{{anchor HotSync Manager API Functions}}HotSync マネージャ API 関数 {{goto top,^TOP^}}
この節ではアプリケーションが HotSync マネージャ アプリケーションを制御するために使用することができる以下の関数について説明します。
,関数,説明
,"{{goto HsCheckApiStatus,HsCheckApiStatus()}}",API が HotSync マネージャ アプリケーションと通信できるかどうかチェックします。
,"{{goto HsDisplayCustomDlg,HsDisplayCustomDlg()}}",HotSync マネージャ アプリケーションの '''Custom''' ダイアログ ボックスを表示します。
,"{{goto HsDisplayFileLink,HsDisplayFileLink()}}",(使用を推奨されなくなりました) HotSync マネージャ アプリケーションの '''File Link''' ウィザードを表示します。
,"{{goto HsDisplayLog,HsDisplayLog()}}",HotSync マネージャ アプリケーションの '''HotSync Log''' ウィンドウを表示します。
,"{{goto HsDisplaySetupDlg,HsDisplaySetupDlg()}}",HotSync マネージャ アプリケーションの '''Setup''' ダイアログ ボックスを表示します。
,"{{goto HsGetApiVersion,HsGetApiVersion()}}",HotSync マネージャ API のバージョンを取得します。
,"{{goto HsGetCommStatus,HsGetCommStatus()}}",HotSync マネージャ接続タイプが使用可能であるかどうかを決定します。
,"{{goto HsGetSyncStatus,HsGetSyncStatus()}}",HotSync マネージャ アプリケーションが現在ハンドヘルドとの同期で Busy 状態であるかどうかを決定します。
,"{{goto HsRefreshConduitInfo,HsRefreshConduitInfo()}}",HotSync マネージャ アプリケーションに登録されているすべてのコンジットについての情報をリロードするようリクエストします。
,"{{goto HsResetComm,HsResetComm()}}",使用可能な HotSync マネージャ通信転送を再初期化します。
,"{{goto HsSetAppStatus,HsSetAppStatus()}}",HotSync マネージャ アプリケーションをクローズ、開始、リスタートします。
,"{{goto HsSetCommStatus,HsSetCommStatus()}}",HotSync マネージャ アプリケーションの通信タイプのステータスをセットします。
!{{anchor HsCheckApiStatus}}HsCheckApiStatus 関数 {{goto top,^TOP^}}
'''目的'''
API が HotSync マネージャ アプリケーションと通信できるかどうかチェックします。
'''宣言されている場所'''
{{span style='color:blue;font-family:monospace;',HSAPI.h}}
'''Prototype'''
long HsCheckApiStatus (
void
)
'''パラメータ'''
ありません。
'''返り値'''
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コードの 1 つを返します。
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_HOTSYNC_NOT_FOUND}}
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_FAILURE}}
すべての HotSync マネージャ API エラー コードの説明は、{{goto HotSync Manager API Error Codes,「HotSync マネージャ API エラー コード」}} を参照してください。
'''コメント'''
他の HotSync マネージャ API 関数を呼び出す前にあなたのアプリケーションが HotSync マネージャ アプリケーションと通信できるかどうかを決定するためにこの関数を呼び出します。
'''互換性'''
*HotSync マネージャ API バージョン: すべて
*Palm OS バージョン: すべて
!{{anchor HsDisplayCustomDlg}}HsDisplayCustomDlg 関数 {{goto top,^TOP^}}
'''目的'''
HotSync マネージャ アプリケーションの '''Custom''' ダイアログ ボックスを表示します。
'''宣言されている場所'''
{{span style='color:blue;font-family:monospace;',HSAPI.h}}
'''Prototype'''
long HsDisplayCustomDlg (
void
)
'''パラメータ'''
ありません。
'''返り値'''
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コードを返します。
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_HOTSYNC_NOT_FOUND}}
すべての HotSync マネージャ API エラー コードの説明は、{{goto HotSync Manager API Error Codes,「HotSync マネージャ API エラー コード」}} を参照してください。
'''コメント'''
'''Custom''' ダイアログ ボックスはユーザが各コンジットの同期設定 - 例えば、同期、デスクトップがハンドヘルドを上書き、など - を閲覧したり変更したりすることを可能にします。
'''互換性'''
*HotSync マネージャ API バージョン: すべて
*Palm OS バージョン: すべて
'''参照'''
{{goto HsDisplaySetupDlg,HsDisplaySetupDlg()}}, {{goto HsDisplayLog,HsDisplayLog()}}, {{goto HsDisplayFileLink,HsDisplayFileLink()}}
!{{anchor HsDisplayFileLink}}HsDisplayFileLink 関数 {{goto top,^TOP^}}
'''目的'''
(使用を推奨されなくなりました) HotSync マネージャ アプリケーションの '''File Link''' ウィザードを表示します。
'''宣言されている場所'''
{{span style='color:blue;font-family:monospace;',HSAPI.h}}
'''Prototype'''
long HsDisplayFileLink (
DWORD dwUserId
)
'''パラメータ'''
*{{span style='color:blue;font-family:monospace;',→ dwUserId}}
**ユーザ ID。これは誰のファイル リンクをセット アップするかを指定します。この値が 0 である場合、現在のユーザのファイル リンク情報が表示されます。
'''返り値'''
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コードを返します。
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_HOTSYNC_NOT_FOUND}}
すべての HotSync マネージャ API エラー コードの説明は、{{goto HotSync Manager API Error Codes,「HotSync マネージャ API エラー コード」}} を参照してください。
'''コメント'''
'''File Link''' ウィザードはユーザが {{goto file link,ファイル リンク|Introduction to Conduit Development601/Glossary}} を作成または変更することを可能にします。
'''互換性'''
*HotSync マネージャ API バージョン: すべて
*Palm OS バージョン: すべて
ファイル リンク Feature は HotSync マネージャ バージョン 6.0.1 以降からは削除されたため、この関数は使用を推奨されなくなりました。
'''参照'''
{{goto HsDisplayCustomDlg,HsDisplayCustomDlg()}}, {{goto HsDisplaySetupDlg,HsDisplaySetupDlg()}}, {{goto HsDisplayLog,HsDisplayLog()}}
!{{anchor HsDisplayLog}}HsDisplayLog 関数 {{goto top,^TOP^}}
'''目的'''
HotSync マネージャ アプリケーションの '''HotSync Log''' ウィンドウを表示します。
'''宣言されている場所'''
{{span style='color:blue;font-family:monospace;',HSAPI.h}}
'''Prototype'''
long HsDisplayLog (
DWORD dwUserId
)
'''パラメータ'''
*{{span style='color:blue;font-family:monospace;',→ dwUserId}}
**ユーザ ID。これは誰のログ情報を表示するかを指定します。この値が 0 である場合、現在のユーザのログが表示されます。
'''返り値'''
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コードを返します。
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_HOTSYNC_NOT_FOUND}}
すべての HotSync マネージャ API エラー コードの説明は、{{goto HotSync Manager API Error Codes,「HotSync マネージャ API エラー コード」}} を参照してください。
'''コメント'''
この関数は '''HotSync Log''' ダイアログ ボックスを表示します。これはユーザが以前の HotSync で書き込まれたログ エントリを閲覧することを可能にします。
'''互換性'''
*HotSync マネージャ API バージョン: すべて
*Palm OS バージョン: すべて
'''参照'''
{{goto HsDisplayCustomDlg,HsDisplayCustomDlg()}}, {{goto HsDisplaySetupDlg,HsDisplaySetupDlg()}}, {{goto HsDisplayFileLink,HsDisplayFileLink()}}
!{{anchor HsDisplaySetupDlg}}HsDisplaySetupDlg 関数 {{goto top,^TOP^}}
'''目的'''
HotSync マネージャ アプリケーションの '''Setup''' ダイアログ ボックスを表示します。
'''宣言されている場所'''
{{span style='color:blue;font-family:monospace;',HSAPI.h}}
'''Prototype'''
long HsDisplaySetupDlg (
void
)
'''パラメータ'''
ありません。
'''返り値'''
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コードを返します。
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_HOTSYNC_NOT_FOUND}}
すべての HotSync マネージャ API エラー コードの説明は、{{goto HotSync Manager API Error Codes,「HotSync マネージャ API エラー コード」}} を参照してください。
'''コメント'''
'''Setup''' ダイアログ ボックスはユーザがシリアル ポートを選択する、モデムをコンフィグレーションする、各ユーザのためのネットワーク HotSync をセット アップすることを可能にします。
'''互換性'''
*HotSync マネージャ API バージョン: すべて
*Palm OS バージョン: すべて
'''参照'''
{{goto HsDisplayCustomDlg,HsDisplayCustomDlg()}}, {{goto HsDisplayLog,HsDisplayLog()}}, {{goto HsDisplayFileLink,HsDisplayFileLink()}}
!{{anchor HsGetApiVersion}}HsGetApiVersion 関数 {{goto top,^TOP^}}
'''目的'''
HotSync マネージャ API のバージョンを取得します。
'''宣言されている場所'''
{{span style='color:blue;font-family:monospace;',HSAPI.h}}
'''Prototype'''
long HsGetApiVersion (
DWORD *pdwVersion
)
'''パラメータ'''
*{{span style='color:blue;font-family:monospace;',←→ pdwVersion}}
**API のバージョンを受け取る {{span style='color:blue;font-family:monospace;',DWORD}} へのポインタ。HotSync マネージャは {{goto HotSync Manager API Versions,「HotSync マネージャ API バージョン」}} で定義されている値の 1 つを返します。
'''返り値'''
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コードを返します。
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_INVALID_POINTER}}
すべての HotSync マネージャ API エラー コードの説明は、{{goto HotSync Manager API Error Codes,「HotSync マネージャ API エラー コード」}} を参照してください。
'''コメント'''
HotSync マネージャ API バージョン番号は HotSync マネージャ アプリケーションのバージョン番号と同じである必要はないということに注意してください。
'''互換性'''
*HotSync マネージャ API バージョン: すべて
*Palm OS バージョン: すべて
'''参照'''
{{goto HotSync Manager API Error Codes,「HotSync マネージャ API エラー コード」}}
!{{anchor HsGetCommStatus}}HsGetCommStatus 関数 {{goto top,^TOP^}}
'''目的'''
HotSync マネージャ接続タイプが使用可能であるかどうかを決定します。
'''宣言されている場所'''
{{span style='color:blue;font-family:monospace;',HSAPI.h}}
'''Prototype'''
long HsGetCommStatus (
HSConnectionType connType,
DWORD *pdwStatus
)
'''パラメータ'''
*{{span style='color:blue;font-family:monospace;',→ connType}}
**ステータスを取得する通信タイプ。{{goto HSConnectionType,HSConnectionType}} 列挙値の 1 つを指定します。
*{{span style='color:blue;font-family:monospace;',← pdwStatus}}
*接続タイプが使用可能であるかどうかを示す {{goto Connection Status Flags,「接続ステータス フラグ」}} で定義されている値の 1 つへのポインタ。
'''返り値'''
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コードを返します。
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_INVALID_CONN_TYPE}}
すべての HotSync マネージャ API エラー コードの説明は、{{goto HotSync Manager API Error Codes,「HotSync マネージャ API エラー コード」}} を参照してください。
'''コメント'''
HotSync マネージャ接続タイプはシリアル、モデム、赤外線通信、ネットワーク、USB を含みます。
'''互換性'''
*HotSync マネージャ API バージョン: すべて
*Palm OS バージョン: すべて
'''参照'''
{{goto HsResetComm,HsResetComm()}}, {{goto HsSetCommStatus,HsSetCommStatus()}}
!{{anchor HsGetSyncStatus}}HsGetSyncStatus 関数 {{goto top,^TOP^}}
'''目的'''
HotSync マネージャ アプリケーションが現在ハンドヘルドとの同期で Busy 状態であるかどうかを決定します。
'''宣言されている場所'''
{{span style='color:blue;font-family:monospace;',HSAPI.h}}
'''Prototype'''
long HsGetSyncStatus (
DWORD *pdwStatus
)
'''パラメータ'''
*{{span style='color:blue;font-family:monospace;',←→ pdwStatus}}
**{{goto HotSync Manager API Error Codes,「HotSync マネージャ API エラー コード」}} で定義されているステータス値の 1 つへのポインタ。
'''返り値'''
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コードの 1 つを返します。
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_HOTSYNC_NOT_FOUND}}
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_INVALID_POINTER}}
すべての HotSync マネージャ API エラー コードの説明は、{{goto HotSync Manager API Error Codes,「HotSync マネージャ API エラー コード」}} を参照してください。
'''互換性'''
*HotSync マネージャ API バージョン: すべて
*Palm OS バージョン: すべて
'''参照'''
{{goto Synchronization Status Flags,「同期ステータス フラグ」}}
!{{anchor HsRefreshConduitInfo}}HsRefreshConduitInfo 関数 {{goto top,^TOP^}}
'''目的'''
HotSync マネージャ アプリケーションに登録されているすべてのコンジットについての情報をリロードするようリクエストします。
'''宣言されている場所'''
{{span style='color:blue;font-family:monospace;',HSAPI.h}}
'''Prototype'''
long HsRefreshConduitInfo (
void
)
'''パラメータ'''
ありません。
'''返り値'''
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コードを返します。
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_HOTSYNC_NOT_FOUND}}
すべての HotSync マネージャ API エラー コードの説明は、{{goto HotSync Manager API Error Codes,「HotSync マネージャ API エラー コード」}} を参照してください。
'''コメント'''
HotSync マネージャ バージョンが 6.0 よりも前のものは、コンジットの登録後にリフレッシュかリスタートしなければなりません。バージョン 6.0 以降はコンジットのリストを自動的にリフレッシュするため、この関数を呼び出す必要はありません。
あなたが HotSync の最中にコンジットを登録する場合、あなたのインストーラは HotSync マネージャにコンジット コンフィグレーション エントリをリロードさせ、あなたの新たに登録されたコンジットを認識させるためにこの関数を呼び出すことができます。あなたのインストーラがコンジットとは関係のない他の設定 (HotSync マネージャ通信設定、バックアップ コンジット、など) を変更した場合、この関数はそれらの設定をリロードしません; 代わりに {{goto HsSetAppStatus,HsSetAppStatus()}} を使用してください。
'''互換性'''
*HotSync マネージャ API バージョン: すべて
*Palm OS バージョン: すべて
'''参照'''
{{goto HsSetAppStatus,HsSetAppStatus()}}
!{{anchor HsResetComm}}HsResetComm 関数 {{goto top,^TOP^}}
'''目的'''
使用可能な HotSync マネージャ通信転送を再初期化します。
'''宣言されている場所'''
{{span style='color:blue;font-family:monospace;',HSAPI.h}}
'''Prototype'''
long HsResetComm (
void
)
'''パラメータ'''
ありません。
'''返り値'''
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コードを返します。
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_HOTSYNC_NOT_FOUND}}
すべての HotSync マネージャ API エラー コードの説明は、{{goto HotSync Manager API Error Codes,「HotSync マネージャ API エラー コード」}} を参照してください。
'''コメント'''
この関数呼び出しは使用可能な状態にある HotSync マネージャ通信転送だけを再初期化します。この関数は使用不可な状態にある転送には影響せず、いずれの転送の使用可能/使用不可ステータスをも変更しません。あなたが転送に変更を加えるためにこの関数以外の HotSync マネージャ API を使用する場合、この関数を呼び出す必要はありません。
'''互換性'''
*HotSync マネージャ API バージョン: すべて
*Palm OS バージョン: すべて
'''参照'''
{{goto HsGetCommStatus,HsGetCommStatus()}}, {{goto HsSetCommStatus,HsSetCommStatus()}}, {{goto HsSetAppStatus,HsSetAppStatus()}}
!{{anchor HsSetAppStatus}}HsSetAppStatus 関数 {{goto top,^TOP^}}
'''目的'''
HotSync マネージャ アプリケーションをクローズ、開始、リスタートします。
'''宣言されている場所'''
{{span style='color:blue;font-family:monospace;',HSAPI.h}}
'''Prototype'''
long HsSetAppStatus (
HsStatusType statusType,
DWORD dwStartFlags
)
'''パラメータ'''
*{{span style='color:blue;font-family:monospace;',→ statusType}}
**HotSync マネージャを開始、停止、リスタートのどれをするかを示す {{goto HsStatusType,HsStatusType}} 列挙値を指定します。
*{{span style='color:blue;font-family:monospace;',→ dwStartFlags}}
**HotSync マネージャを開始またはリスタートさせる場合、{{goto Start Options,「開始オプション」}} で定義されているスタート オプションの有効な組み合わせを指定してください。
'''返り値'''
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コードの 1 つを返します。
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_UNABLE_TO_CLOSE}}
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_UNKNOWN_STATUS_TYPE}}
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_UNABLE_TO_START}}
すべての HotSync マネージャ API エラー コードの説明は、{{goto HotSync Manager API Error Codes,「HotSync マネージャ API エラー コード」}} を参照してください。
'''コメント'''
あなたが {{span style='color:blue;font-family:monospace;',statusType}} パラメータを {{span style='color:blue;font-family:monospace;',HsRestart}} にセットし、HotSync マネージャがすでに自己宇宙である場合、この関数は HotSync をクローズし、 {{span style='color:blue;font-family:monospace;',dwStartFlags}} フラグ経由で渡されたオプションで開始します。
::NOTE
:::あなたがコンフィグレーション エントリのいずれかを変更した場合は常に、HotSync マネージャ バージョン 6.0 より前のものはあなたが HotSync マネージャにほとんどのコンジット コンフィグレーション変更を認識させるために {{goto HsSetAppStatus,HsSetAppStatus()}} を呼び出すか、あるコンジット コンフィグレーション変更を認識させるために {{goto HsRefreshConduitInfo,HsRefreshConduitInfo()}} を呼び出すことを必要とします。{{br}}{{br}}しかしながら、HotSync マネージャ バージョン 6.0 以降はあなたがこれらの関数を呼び出すこと無しに自動的にコンジット コンフィグレーション情報への変更を発見します。他の変更 (HotSync マネージャ通信設定、バックアップ コンジット、など) を認識させるには、あなたは HotSync マネージャをリスタートさせるためにやはり {{span style='color:blue;font-family:monospace;',HsSetAppStatus()}} を呼び出さなければなりません。
あなたが {{span style='color:blue;font-family:monospace;',statusType}} パラメータに {{span style='color:blue;font-family:monospace;',HsStartApp}} をセットし、HotSync マネージャがすでに実行中である場合、この関数は {{span style='color:blue;font-family:monospace;',dwStartFlags}} フラグヲ無視し、エラーを発生しません。
あなたが {{span style='color:blue;font-family:monospace;',statusType}} パラメータに {{span style='color:blue;font-family:monospace;',HsCloseApp}} をセットし、HotSync マネージャが実行中でない場合、この関数はエラーを発生しません。
'''互換性'''
*HotSync マネージャ API バージョン: すべて
*Palm OS バージョン: すべて
'''参照'''
{{goto HsResetComm,HsResetComm()}}, {{goto HsRefreshConduitInfo,HsRefreshConduitInfo()}}
!{{anchor HsSetCommStatus}}HsSetCommStatus 関数 {{goto top,^TOP^}}
'''目的'''
HotSync マネージャ アプリケーションの通信タイプのステータスをセットします。
'''宣言されている場所'''
{{span style='color:blue;font-family:monospace;',HSAPI.h}}
'''Prototype'''
long HsSetCommStatus (
HSConnectionType connType,
DWORD dwStatus
)
'''パラメータ'''
*{{span style='color:blue;font-family:monospace;',→ connType}}
**ステータスをセットする通信タイプ。{{goto HSConnectionType,HSConnectionType}} 列挙値の 1 つを指定します。
*{{span style='color:blue;font-family:monospace;',→ dwStatus}}
**通信タイプを使用可能あるいは使用不可にします。{{goto Connection Status Flags,「接続ステータス フラグ」}} で定義されている値の 1 つを指定します。
'''返り値'''
成功した場合、0 を返します。
失敗した場合、以下の非 0 のエラー コードの 1 つを返します。
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_INVALID_STATUS_FLAG}}
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_INVALID_CONN_TYPE}}
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_FAILURE}}
*{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_REG_FAILURE}}
すべての HotSync マネージャ API エラー コードの説明は、{{goto HotSync Manager API Error Codes,「HotSync マネージャ API エラー コード」}} を参照してください。
'''コメント'''
HotSync マネージャが実行中である場合、この関数は HotSync マネージャに指定された通信タイプのステータスを変更するようリクエストします。HotSync マネージャが実行中でない場合、この関数は HotSync マネージャの保存されている設定をコンフィグレートします。
'''互換性'''
*HotSync マネージャ API バージョン: すべて
*Palm OS バージョン: すべて
'''参照'''
{{goto HsResetComm,HsResetComm()}}, {{goto HsGetCommStatus,HsGetCommStatus()}}
!!{{anchor HotSync Manager API Error Codes}}HotSync マネージャ API エラー コード {{goto top,^TOP^}}
{{goto Table 14.1,表 14.1}} は HotSync マネージャ API 関数が返す可能性があるエラー コードの値をリスト アップしています。各関数の説明で、その関数が返す可能性があるエラーはどれなのかを述べています。
以下の名前を付けられているエラー コードはすべてプロセッサ定数として定義されています。これらは {{span style='color:blue;font-family:monospace;',HSAPI.h}} ヘッダ ファイルで宣言されています。
{{anchor Table 14.1}}
'''表 14.1 HotSync マネージャ API エラー コード'''
,値,コード,説明
,-1,-,特定されていないエラーが起こりました。
,0x10000000,"{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_ERROR_BASE}}",この値を返す関数はありません。これはオフセットであり、他のすべてのエラー コードがこれをベースにします。
,0x10000001,"{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_HOTSYNC_NOT_FOUND}}",HotSync マネージャは実行中ではありません。
,0x10000002,"{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_INVALID_CONN_TYPE}}","指定された接続タイプは {{goto HSConnectionType,HSConnectionType}} 列挙体によって定義されたものではありません。"
,0x10000003,"{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_FAILURE}}",API は HotSync マネージャと通信することができません。
,0x10000004,"{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_REG_FAILURE}}",API はコンフィグレーション エントリにアクセスすることができません。
,0x10000005,"{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_UNKNOWN_STATUS_TYPE}}","指定されたステータス タイプは {{goto HsStatusType,HsStatusType}} 列挙体によって定義されたものではありません。"
,0x10000006,"{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_UNABLE_TO_CLOSE}}",API は HotSync マネージャ アプリケーションをクローズすることができません。
,0x10000007,"{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_NO_HOTSYNC_PATH}}",HotSync マネージャ パスを見つけることができませんでした。
,0x10000008,"{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_UNABLE_TO_START}}",API は HotSync マネージャ アプリケーションを開始することができません。
,0x10000009,"{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_INVALID_STATUS_FLAG}}","指定された接続タイプ ステータスは {{goto Connection Status Flags,「接続ステータス フラグ」}} で定義されたものではありません。"
,0x10000010,"{{span style='color:blue;font-family:monospace;',ERROR_HSAPI_INVALID_POINTER}}",この関数に渡されたポインタは無効です。
{{div_end}}
{{div_begin "style='border-top-style:solid;border-top-width:1px;border-top-color:silver;'"}}
[[← 13 章に戻る|C/C++ Sync Suite Reference601/13]] [[↑トップへ|C/C++ Sync Suite Reference601]] [[15 章に進む →|C/C++ Sync Suite Reference601/15]]
{{div_end}}
