System.Net.URLClient.TURLClient.BeginExecute

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

function BeginExecute(const ARequestMethod: string; const AURI: TURI; const ASourceStream: TStream = nil;  const AContentStream: TStream = nil; const AHeaders: TNetHeaders = nil): IAsyncResult; overload;
function BeginExecute(const AsyncCallbackEvent: TAsyncCallbackEvent; const ARequestMethod: string; const AURI: TURI; const ASourceStream: TStream = nil;  const AContentStream: TStream = nil; const AHeaders: TNetHeaders = nil): IAsyncResult; overload;
function BeginExecute(const AsyncCallback: TAsyncCallback; const ARequestMethod: string; const AURI: TURI; const ASourceStream: TStream = nil;  const AContentStream: TStream = nil; const AHeaders: TNetHeaders = nil): IAsyncResult; overload;
function BeginExecute(const ARequestMethod: string; const AURIStr: string; const ASourceStream: TStream = nil;  const AContentStream: TStream = nil; const AHeaders: TNetHeaders = nil): IAsyncResult; overload;
function BeginExecute(const AsyncCallbackEvent: TAsyncCallbackEvent; const ARequestMethod: string; const AURIStr: string; const ASourceStream: TStream = nil;  const AContentStream: TStream = nil; const AHeaders: TNetHeaders = nil): IAsyncResult; overload;
function BeginExecute(const AsyncCallback: TAsyncCallback; const ARequestMethod: string; const AURIStr: string; const ASourceStream: TStream = nil;  const AContentStream: TStream = nil; const AHeaders: TNetHeaders = nil): IAsyncResult; overload;

C++

System::Types::_di_IAsyncResult __fastcall BeginExecute(const System::UnicodeString ARequestMethod, const TURI &AURI, System::Classes::TStream* const ASourceStream = (System::Classes::TStream*)(0x0), System::Classes::TStream* const AContentStream = (System::Classes::TStream*)(0x0), const System::DynamicArray<TNameValuePair> AHeaders = System::DynamicArray<TNameValuePair>())/* overload */;
System::Types::_di_IAsyncResult __fastcall BeginExecute(const System::Classes::TAsyncProcedureEvent AsyncCallbackEvent, const System::UnicodeString ARequestMethod, const TURI &AURI, System::Classes::TStream* const ASourceStream = (System::Classes::TStream*)(0x0), System::Classes::TStream* const AContentStream = (System::Classes::TStream*)(0x0), const System::DynamicArray<TNameValuePair> AHeaders = System::DynamicArray<TNameValuePair>())/* overload */;
System::Types::_di_IAsyncResult __fastcall BeginExecute(const System::Classes::_di_TAsyncCallback AsyncCallback, const System::UnicodeString ARequestMethod, const TURI &AURI, System::Classes::TStream* const ASourceStream = (System::Classes::TStream*)(0x0), System::Classes::TStream* const AContentStream = (System::Classes::TStream*)(0x0), const System::DynamicArray<TNameValuePair> AHeaders = System::DynamicArray<TNameValuePair>())/* overload */;
System::Types::_di_IAsyncResult __fastcall BeginExecute(const System::UnicodeString ARequestMethod, const System::UnicodeString AURIStr, System::Classes::TStream* const ASourceStream = (System::Classes::TStream*)(0x0), System::Classes::TStream* const AContentStream = (System::Classes::TStream*)(0x0), const System::DynamicArray<TNameValuePair> AHeaders = System::DynamicArray<TNameValuePair>())/* overload */;
System::Types::_di_IAsyncResult __fastcall BeginExecute(const System::Classes::TAsyncProcedureEvent AsyncCallbackEvent, const System::UnicodeString ARequestMethod, const System::UnicodeString AURIStr, System::Classes::TStream* const ASourceStream = (System::Classes::TStream*)(0x0), System::Classes::TStream* const AContentStream = (System::Classes::TStream*)(0x0), const System::DynamicArray<TNameValuePair> AHeaders = System::DynamicArray<TNameValuePair>())/* overload */;
System::Types::_di_IAsyncResult __fastcall BeginExecute(const System::Classes::_di_TAsyncCallback AsyncCallback, const System::UnicodeString ARequestMethod, const System::UnicodeString AURIStr, System::Classes::TStream* const ASourceStream = (System::Classes::TStream*)(0x0), System::Classes::TStream* const AContentStream = (System::Classes::TStream*)(0x0), const System::DynamicArray<TNameValuePair> AHeaders = System::DynamicArray<TNameValuePair>())/* overload */;

プロパティ

種類 可視性 ソース ユニット
function public
System.Net.URLClient.pas
System.Net.URLClient.hpp
System.Net.URLClient TURLClient


説明

非同期 URL リクエストを開始します。

BeginExecute を呼び出す際、URL リクエストを実行するのに必要なデータを提供しなければなりません:

  • ARequestMethod は、使用するリクエスト メソッドを定義する文字列です。 利用可能nリクエスト メソッドは、プロトコルによって変わります。
  • AURITURI)または AURIStr文字列)は、要求するリソースの場所を識別する URI です。
  • ASourceStream(省略可能)は、リクエストで提供されるデータのストリームです。
  • AContentStream(省略可能)は、レスポンスに含まれるデータを保持するストリームです。
  • AHeaders(省略可能)は、リクエストに含まれるヘッダーのリストです。
  • AsyncCallback(省略可能)は、レスポンスが受け取られたとき、またはリクエストが失敗した際に呼び出されるコールバック プロシージャです。
  • AsyncCallbackEvent(省略可能) はイベント ハンドラで、レスポンスが受けたられたとき呼び出され、AsyncCallback が nil の際にはリクエストは失敗します。

BeginExecute は、非同期にレスポンス データの設定を開始する、レスポンス オブジェクトを返します。

すべてのレスポンス データが非同期結果オブジェクトに受け取られると、コールバック関数またはイベント ハンドラが呼び出され、対応する非同期結果オブジェクトがパラメータとして提供されます。

オペレーションが正常終了したかを確認するために、EndAsyncURL をターゲットのレスポンス オブジェクトをパラメータにして呼び出します。リクエストの間に問題があった場合(タイムアウトなど)、EndAsyncURL は例外を発生させます。

通常は、EndAsyncURL を、レスポンス データがすでに受信されていることがわかっている、コールバック関数またはイベント ハンドラの中から呼び出します。 しかし、実際には EndAsyncURL をどのタイミングでも呼び出すことができ、プログラムの実行をレスポンス データが受信されるまで止め、効果的に、非同期リクエストを同期リクエストに変えることができます。

関連項目