System.Net.HttpClient.THTTPClient.BeginOptions

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function BeginOptions(const AURL: string; const AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil): IHTTPResponse; overload;
function BeginOptions(const AsyncCallback: TAsyncCallback; const AURL: string; const AResponseContent: TStream = nil;  const AHeaders: TNetHeaders = nil): IHTTPResponse; overload;
function BeginOptions(const AsyncCallbackEvent: TAsyncCallbackEvent; const AURL: string; const AResponseContent: TStream = nil;  const AHeaders: TNetHeaders = nil): IHTTPResponse; overload;

C++

_di_IHTTPResponse __fastcall BeginOptions(const System::UnicodeString AURL, System::Classes::TStream* const AResponseContent = (System::Classes::TStream*)(0x0), const System::DynamicArray<System::Net::Urlclient::TNameValuePair> AHeaders = System::DynamicArray<System::Net::Urlclient::TNameValuePair>())/* overload */;
_di_IHTTPResponse __fastcall BeginOptions(const System::Classes::_di_TAsyncCallback AsyncCallback, const System::UnicodeString AURL, System::Classes::TStream* const AResponseContent = (System::Classes::TStream*)(0x0), const System::DynamicArray<System::Net::Urlclient::TNameValuePair> AHeaders = System::DynamicArray<System::Net::Urlclient::TNameValuePair>())/* overload */;
_di_IHTTPResponse __fastcall BeginOptions(const System::Classes::TAsyncProcedureEvent AsyncCallbackEvent, const System::UnicodeString AURL, System::Classes::TStream* const AResponseContent = (System::Classes::TStream*)(0x0), const System::DynamicArray<System::Net::Urlclient::TNameValuePair> AHeaders = System::DynamicArray<System::Net::Urlclient::TNameValuePair>())/* overload */;

Properties

Type Visibility Source Unit Parent
function public
System.Net.HTTPClient.pas
System.Net.HTTPClient.hpp
System.Net.HttpClient THTTPClient

Description

Starts an asynchronous HTTP request using the OPTIONS HTTP request method.

When you call BeginOptions, you must provide the data required to perform your HTTP request:

  • AURL is the target URL of your request.
  • AResponseContent (optional) is a stream where you want to receive the response data as your HTTP client downloads the response data from the target server.

    If you do not specify a stream for AResponseContent, you can wait for your HTTP client to download the whole response data, and obtain the response data as a stream from the ContentStream property of the response object that BeginGet returns.
  • AHeaders (optional) is a list of headers to include in the request.
  • AsyncCallback (optional) is a callback procedure to be called when a response is received or the request fails.
  • AsyncCallbackEvent (optional) is an event handler to be called when a response is received or the request fails.

For more information, see BeginExecute.

See Also