NHTTP_GetHeaderField

構文


#include <nitroWiFi/nhttp.h>

int NHTTP_GetHeaderField( NHTTPConnectionHandle handle, const char* label, char** value );

引数

handle NHTTP_CreateConnection()で生成した接続ハンドル
label 取得を試みるヘッダ情報のラベル名
value 取得結果のアドレスを格納するためのポインタへのポインタ。
返されたポインタが指す先を変更することはできません。

返り値

指定したラベルが存在すればその値の文字数を返します。
そうでない場合は負の値を返します。

説明

接続ハンドルのHTTPレスポンスヘッダ情報から、指定したラベル名に対応する値を文字列で取得します。

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

参照

NHTTP_STATUS_RECEIVING_BODY,
NHTTP_GetHeaderAll, NHTTP_StartConnection, NHTTP_GetConnectionStatus

履歴

2006/10/19 引数に関する注意事項など、説明を追記。
2006/6/26 初版。