WCM_TerminateAsync

構文


#include <nitroWiFi/wcm.h>

s32   WCM_TerminateAsync( void );
				

説明

非同期処理が行われていない内部状態から WCM ライブラリの強制停止シーケンスを開始する非同期関数です。
非同期処理が正常に開始された場合に内部状態は WCM_PHASE_TERMINATING に変化し、 非同期処理が正常に完了した際に WCM_PHASE_WAIT となります。初期化前の状態にまで戻る訳ではありません。 当関数は内部状態が WCM_PHASE_WAITWCM_PHASE_IDLEWCM_PHASE_SEARCHWCM_PHASE_DCFWCM_PHASE_IRREGULAR である場合に 実行することができますが、なんらかの非同期処理中及び WCM_PHASE_FATAL_ERROR である場合は実行することができません。

返り値が WCM_RESULT_ACCEPT であった場合には、対応する非同期処理通知が必ず一回発生し、コールバック関数が呼び出されます。

引数

ありません。

返り値

以下のいずれかの処理結果を返します。

WCM_RESULT_ACCEPT 非同期シーケンス開始要求が受け付けられ、正常に非同期処理が開始されたことを示します。 非同期処理が終了した際に必ず一回コールバック関数が呼び出されます。
WCM_RESULT_PROGRESS 当関数によって開始された非同期シーケンスが既に実行中であり、多重呼び出しであったことを示します。 多重に呼び出しても非同期処理終了通知は一回しか発生しません。
WCM_RESULT_SUCCESS WCM ライブラリの強制停止シーケンスが既に完了しており、内部状態が WCM_PHASE_WAIT であったことを示します。 非同期処理は開始されませんので、非同期処理終了通知も発生しません。
WCM_RESULT_REJECT WCM ライブラリの強制停止シーケンスを開始しようとした際に、ARM7 への PXI 処理要求の発行に失敗したことを示します。 内部状態は当関数呼び出し時から変更されていませんので、リトライすることができます。
WCM_RESULT_FAILURE WCM ライブラリが初期化されていない、内部状態が実行に適していない、などの原因で処理に失敗したことを示します。
WCM_RESULT_FATAL_ERROR 復旧不可能なエラーが発生したことを示します。内部状態は WCM_PHASE_FATAL_ERROR となり、以後変更されません。

非同期処理結果

WCM_StartupAsync()で指定したコールバック関数に以下のいずれかの非同期処理結果が渡されます。 通知種別は WCM_NOTIFY_TERMINATE に固定となります。

WCM_RESULT_SUCCESS 非同期処理に成功し、正常に WCM ライブラリが強制停止されたことを示します。内部状態は WCM_PHASE_WAIT となります。
WCM_RESULT_FAILURE 非同期処理の途中で WM ライブラリから何らかのエラー通知を受けたことを示します。 内部状態は WCM_PHASE_IRREGULAR となります。
WCM_RESULT_FATAL_ERROR 非同期処理の途中で復旧不可能なエラーが発生したことを示します。内部状態は WCM_PHASE_FATAL_ERROR となり、以後変更されません。

参照

WCM_Finish, WCM_StartupAsync, WCM_CleanupAsync

履歴

2005/07/22 初版