System.Net.HttpClient.THTTPClient.BeginPost

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function BeginPost(const AURL: string; const ASourceFile: string; const AResponseContent: TStream = nil;  const AHeaders: TNetHeaders = nil): IAsyncResult; overload;
function BeginPost(const AsyncCallback: TAsyncCallback; const AURL: string; const ASourceFile: string; const AResponseContent: TStream = nil;  const AHeaders: TNetHeaders = nil): IAsyncResult; overload;
function BeginPost(const AsyncCallbackEvent: TAsyncCallbackEvent; const AURL: string; const ASourceFile: string; const AResponseContent: TStream = nil;  const AHeaders: TNetHeaders = nil): IAsyncResult; overload;
function BeginPost(const AURL: string; const ASource: TStrings; const AResponseContent: TStream = nil;  const AEncoding: TEncoding = nil; const AHeaders: TNetHeaders = nil): IAsyncResult; overload;
function BeginPost(const AsyncCallback: TAsyncCallback; const AURL: string; const ASource: TStrings;  const AResponseContent: TStream = nil; const AEncoding: TEncoding = nil; const AHeaders: TNetHeaders = nil): IAsyncResult; overload;
function BeginPost(const AsyncCallbackEvent: TAsyncCallbackEvent; const AURL: string; const ASource: TStrings;  const AResponseContent: TStream = nil; const AEncoding: TEncoding = nil; const AHeaders: TNetHeaders = nil): IAsyncResult; overload;
function BeginPost(const AURL: string; const ASource: TStream; const AResponseContent: TStream = nil;  const AHeaders: TNetHeaders = nil): IAsyncResult; overload;
function BeginPost(const AsyncCallback: TAsyncCallback; const AURL: string; const ASource: TStream;  const AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil): IAsyncResult; overload;
function BeginPost(const AsyncCallbackEvent: TAsyncCallbackEvent; const AURL: string; const ASource: TStream;  const AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil): IAsyncResult; overload;
function BeginPost(const AURL: string; const ASource: TMultipartFormData; const AResponseContent: TStream = nil;  const AHeaders: TNetHeaders = nil): IAsyncResult; overload;
function BeginPost(const AsyncCallback: TAsyncCallback; const AURL: string; const ASource: TMultipartFormData;  const AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil): IAsyncResult; overload;
function BeginPost(const AsyncCallbackEvent: TAsyncCallbackEvent; const AURL: string; const ASource: TMultipartFormData;  const AResponseContent: TStream = nil; const AHeaders: TNetHeaders = nil): IAsyncResult; overload;

C++

System::Types::_di_IAsyncResult __fastcall BeginPost(const System::UnicodeString AURL, const System::UnicodeString ASourceFile, System::Classes::TStream* const AResponseContent = (System::Classes::TStream*)(0x0), const System::DynamicArray<System::Net::Urlclient::TNameValuePair> AHeaders = System::DynamicArray<System::Net::Urlclient::TNameValuePair>())/* overload */;
System::Types::_di_IAsyncResult __fastcall BeginPost(const System::Classes::_di_TAsyncCallback AsyncCallback, const System::UnicodeString AURL, const System::UnicodeString ASourceFile, System::Classes::TStream* const AResponseContent = (System::Classes::TStream*)(0x0), const System::DynamicArray<System::Net::Urlclient::TNameValuePair> AHeaders = System::DynamicArray<System::Net::Urlclient::TNameValuePair>())/* overload */;
System::Types::_di_IAsyncResult __fastcall BeginPost(const System::Classes::TAsyncProcedureEvent AsyncCallbackEvent, const System::UnicodeString AURL, const System::UnicodeString ASourceFile, System::Classes::TStream* const AResponseContent = (System::Classes::TStream*)(0x0), const System::DynamicArray<System::Net::Urlclient::TNameValuePair> AHeaders = System::DynamicArray<System::Net::Urlclient::TNameValuePair>())/* overload */;
System::Types::_di_IAsyncResult __fastcall BeginPost(const System::UnicodeString AURL, System::Classes::TStrings* const ASource, System::Classes::TStream* const AResponseContent = (System::Classes::TStream*)(0x0), System::Sysutils::TEncoding* const AEncoding = (System::Sysutils::TEncoding*)(0x0), const System::DynamicArray<System::Net::Urlclient::TNameValuePair> AHeaders = System::DynamicArray<System::Net::Urlclient::TNameValuePair>())/* overload */;
System::Types::_di_IAsyncResult __fastcall BeginPost(const System::Classes::_di_TAsyncCallback AsyncCallback, const System::UnicodeString AURL, System::Classes::TStrings* const ASource, System::Classes::TStream* const AResponseContent = (System::Classes::TStream*)(0x0), System::Sysutils::TEncoding* const AEncoding = (System::Sysutils::TEncoding*)(0x0), const System::DynamicArray<System::Net::Urlclient::TNameValuePair> AHeaders = System::DynamicArray<System::Net::Urlclient::TNameValuePair>())/* overload */;
System::Types::_di_IAsyncResult __fastcall BeginPost(const System::Classes::TAsyncProcedureEvent AsyncCallbackEvent, const System::UnicodeString AURL, System::Classes::TStrings* const ASource, System::Classes::TStream* const AResponseContent = (System::Classes::TStream*)(0x0), System::Sysutils::TEncoding* const AEncoding = (System::Sysutils::TEncoding*)(0x0), const System::DynamicArray<System::Net::Urlclient::TNameValuePair> AHeaders = System::DynamicArray<System::Net::Urlclient::TNameValuePair>())/* overload */;
System::Types::_di_IAsyncResult __fastcall BeginPost(const System::UnicodeString AURL, System::Classes::TStream* const ASource, System::Classes::TStream* const AResponseContent = (System::Classes::TStream*)(0x0), const System::DynamicArray<System::Net::Urlclient::TNameValuePair> AHeaders = System::DynamicArray<System::Net::Urlclient::TNameValuePair>())/* overload */;
System::Types::_di_IAsyncResult __fastcall BeginPost(const System::Classes::_di_TAsyncCallback AsyncCallback, const System::UnicodeString AURL, System::Classes::TStream* const ASource, System::Classes::TStream* const AResponseContent = (System::Classes::TStream*)(0x0), const System::DynamicArray<System::Net::Urlclient::TNameValuePair> AHeaders = System::DynamicArray<System::Net::Urlclient::TNameValuePair>())/* overload */;
System::Types::_di_IAsyncResult __fastcall BeginPost(const System::Classes::TAsyncProcedureEvent AsyncCallbackEvent, const System::UnicodeString AURL, System::Classes::TStream* const ASource, System::Classes::TStream* const AResponseContent = (System::Classes::TStream*)(0x0), const System::DynamicArray<System::Net::Urlclient::TNameValuePair> AHeaders = System::DynamicArray<System::Net::Urlclient::TNameValuePair>())/* overload */;
System::Types::_di_IAsyncResult __fastcall BeginPost(const System::UnicodeString AURL, System::Net::Mime::TMultipartFormData* const ASource, System::Classes::TStream* const AResponseContent = (System::Classes::TStream*)(0x0), const System::DynamicArray<System::Net::Urlclient::TNameValuePair> AHeaders = System::DynamicArray<System::Net::Urlclient::TNameValuePair>())/* overload */;
System::Types::_di_IAsyncResult __fastcall BeginPost(const System::Classes::_di_TAsyncCallback AsyncCallback, const System::UnicodeString AURL, System::Net::Mime::TMultipartFormData* const ASource, System::Classes::TStream* const AResponseContent = (System::Classes::TStream*)(0x0), const System::DynamicArray<System::Net::Urlclient::TNameValuePair> AHeaders = System::DynamicArray<System::Net::Urlclient::TNameValuePair>())/* overload */;
System::Types::_di_IAsyncResult __fastcall BeginPost(const System::Classes::TAsyncProcedureEvent AsyncCallbackEvent, const System::UnicodeString AURL, System::Net::Mime::TMultipartFormData* const ASource, 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 POST HTTP request method.

To specify the data to send when you call BeginPost, do any of the following:

  • To send the content of a local file, specify the local path of that file as ASourceFile.
  • To send the content of a string list, provide your instance of TStrings as ASource, and if your strings are not encoded in UTF-8, provide an instance of TEncoding as AEncoding.
  • To send the content of a stream, provide your instance of TStream as ASource.
  • To send form data encoded as a MIME multipart message following the HTML 4 standard, provide your instance of TMultipartFormData as ASource.

BeginPost also receives the following parameters:

  • 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 asynchronous result object that BeginPost 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