NHTTP_AddPostDataAscii

構文


#include <nitroWiFi/nhttp.h>

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

引数

handle NHTTP_CreateConnection()で生成した接続ハンドル
label 追加するHTTPリクエストPOST項目のラベル(NULL終端ASCII文字列)へのポインタ
このポインタの指す先は接続ハンドルが解放されるまでライブラリ内部で参照される点に注意してください。
value 追加するHTTPリクエストPOST項目の値(NULL終端ASCII文字列)へのポインタ
送信すべきデータをこの場で用意しない場合にはNULLを指定することもできます。その場合、 必要に応じてNHTTP_EVENT_POST_SENDコールバックが通知されますので、 その場で適切に応答する必要があります。
このポインタの指す先は接続ハンドルが解放されるまでライブラリ内部で参照される点に注意してください。

返り値

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

説明

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

注意

この関数は、ラベル無しで単一のデータをそのまま送信するNHTTP_AddPostDataRaw()と併用することはできません。

参照

NHTTPConnectionCallback, NHTTP_AddPostDataBinary, NHTTP_AddPostDataRaw, NHTTP_SetPostDataEncoding, NHTTP_StartConnection

履歴

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