NHTTP_GetResultCode

構文


#include <nitroWiFi/nhttp.h>

int NHTTP_GetResultCode( NHTTPConnectionHandle handle );

引数

handle NHTTP_CreateConnection()で生成した接続ハンドル

返り値

リザルトコードが正常に取得できればその値を返します。
そうでない場合は負の値を返します。

説明

接続ハンドルのHTTPレスポンスヘッダに含まれるリザルトコードを整数として取得します。
この値はサーバが応答するHTTPプロトコルとしてのレスポンスであり、 NHTTP_ライブラリが規定しているNHTTPError型の列挙値ではないという点に 注意してください。

この関数は、実際に通信が行われHTTPレスポンスヘッダを全て受信したあとに限り使用することが出来ます。
NHTTP_GetConnectionStatus()NHTTP_STATUS_RECEIVING_BODY以降を返す状態が それに該当します。

参照

NHTTP_STATUS_RECEIVING_BODY, NHTTPError,
NHTTP_GetHeaderAll, NHTTP_StartConnection, NHTTP_GetConnectionStatus

履歴

2006/10/19 返り値の意味に関して、説明を追記。
2006/9/13 初版。