SOC_GetConfigError

構文

#include <nitroWiFi/soc.h>
#define SOC_IP_ERR_DHCP_TIMEOUT    -100
#define SOC_IP_ERR_LINK_DOWN       -112
s32 SOC_GetConfigError ( SOCInterface* interface );

引数

interface エラーコードを取得するSOCInterfaceへのポインタ。この引数は互換性のため用意されていますが、実際には無視されます。

返り値

0 成功。
SOC_IP_ERR_DHCP_TIMEOUT DHCPサーバーが見つかりません。
SOC_IP_ERR_LINK_DOWN リンク切れが発生しました。

注意:追加のエラーが今後のライブラリリリースで生じたり返されることがあります。すべての負の返り値は汎用のエラーとして扱ってください。

説明

ホスト設定のエラーコードを取得します。エラーコードはスティッキーコードで、SOC_ClearConfigError()が呼ばれるまでクリアされません。
SOC_GetConfigError()SOC_Startup()でホストのIPv4アドレスが手動で設定された場合、SOC_IP_ERR_DHCP_TIMEOUTを返します。

参照

SOC_ClearConfigError

履歴

2008/05/14 説明を修正
2005/12/12 説明の記述変更
2005/09/13 初版