NHTTP_CancelConnection

構文


#include <nitroWiFi/nhttp.h>

NHTTPError NHTTP_CancelConnection(NHTTPConnectionHandle handle);

引数

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

返り値

正常にキャンセル要求が受理されればNHTTP_ERROR_NONEを、
失敗すればNHTTPError型のいずれかのエラー値を返します。

説明

NHTTP_StartConnection()で開始した通信処理をキャンセルします。

ライブラリの内部状態によってはキャンセルがただちに受理されるとは限りません。 通信完了までその場で待機したい場合はNHTTP_WaitForConnection()を使用します。

通信を開始していないか、または通信処理が完了している場合には、何も行いません。

注意

イベント通知コールバック内からこの関数を呼び出すことはできません。 その場合、ライブラリは警告メッセージをデバッグ出力して強制停止します。
詳細はNHTTPConnectionCallbackの項をご参照ください。

参照

NHTTP_CreateConnection, NHTTP_StartConnection, NHTTP_WaitForConnection, NHTTP_GetConnectionError

履歴

2006/10/14 初版