NHTTP_AddHeaderField

構文


#include <nitroWiFi/nhttp.h>

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

引数

handle NHTTP_CreateConnection()で生成した接続ハンドル
label 追加するHTTPリクエストヘッダ項目のラベル(NULL終端ASCII文字列)へのポインタ
このポインタの指す先は接続ハンドルが解放されるまでライブラリ内部で参照される点に注意してください。
value 追加するHTTPリクエストヘッダ項目の値(NULL終端ASCII文字列)へのポインタ
このポインタの指す先は接続ハンドルが解放されるまでライブラリ内部で参照される点に注意してください。

返り値

ヘッダ項目の追加に成功すれば0を、
接続ハンドルがNULLの場合、
NHTTP_StartConnection()で通信処理を開始した接続ハンドルに設定しようとした場合、
内部処理でリスト要素追加時にメモリ確保に失敗した場合に失敗し-1を返します。

説明

送信すべきHTTPリクエストヘッダ項目を追加します。
この関数はNHTTP_StartConnection()の呼び出しより前に、 必要に応じて任意の回数呼び出すことが出来ます。

参照

NHTTP_StartConnection

履歴

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