System.Net.HttpClientComponent.TNetHTTPClient.Put

From RAD Studio API Documentation
Jump to: navigation, search

Delphi 

function Put(const AURL: string; const ASourceFile: string; const AResponseContent: TStream = nil;  const AHeaders: TNetHeaders = nil): IHTTPResponse; overload;
function Put(const AURL: string; const ASource: TStrings; const AResponseContent: TStream = nil;  const AEncoding: TEncoding = nil; const AHeaders: TNetHeaders = nil): IHTTPResponse; overload;
function Put(const AURL: string; const ASource: TStream = nil; const AResponseContent: TStream = nil;  const AHeaders: TNetHeaders = nil): IHTTPResponse; overload;
function Put(const AURL: string; const ASource: TMultipartFormData; const AResponseContent: TStream = nil;  const AHeaders: TNetHeaders = nil): IHTTPResponse; overload;

C++ 

System::Net::Httpclient::_di_IHTTPResponse __fastcall Put(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::Net::Httpclient::_di_IHTTPResponse __fastcall Put(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::Net::Httpclient::_di_IHTTPResponse __fastcall Put(const System::UnicodeString AURL, System::Classes::TStream* const ASource = (System::Classes::TStream*)(0x0), 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::Net::Httpclient::_di_IHTTPResponse __fastcall Put(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.HTTPClientComponent.pas
System.Net.HTTPClientComponent.hpp
 System.Net.HttpClientComponent TNetHTTPClient

Description

Sends an HTTP request to the specified URL with the specified data (ASource) using the PUT HTTP request method, waits for the server to send a response, and returns the HTTP response of the server.

If you want to receive the response data as your HTTP client downloads it from the target server, instead of waiting for your HTTP client to download the whole data, use the AResponseContent parameter to specify a stream to receive the downloaded data. Alternatively, 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 Get returns.

Regardless of whether you receive the data as it comes or wait for the whole data to be available, you can handle the OnReceiveData event to track the progress of the download of the response data.

Use AHeaders to include custom HTTP request headers in your HTTP request.

Put also receives the following parameters:

  • ASourceFile: string is the specified local path to send the content of a local file.
  • ASource: TStrings is a TStrings instance that once provided, sends the content of a string list.
  • ASource: TMultipartFormData is a TMultipartFormData instance that once provided, sends form data encoded as a MIME multipart message following the HTML 4 standard.

Put raises an ENetHTTPRequestException if the HTTP request reaches the maximum number of redirects.

See Also

Retrieved from "http://docwiki.embarcadero.com/Libraries/Sydney/e/index.php?title=System.Net.HttpClientComponent.TNetHTTPClient.Put&oldid=826173"