System.Net.HttpClientComponent.TNetHTTPClient.Delete

From RAD Studio API Documentation
Jump to: navigation, search

Delphi 

function Delete(const AURL: string; const AResponseContent: TStream = nil;
const AHeaders: TNetHeaders = nil): IHTTPResponse; overload;
function Delete(const AURL: string; const ASource, AResponseContent: TStream;
const AHeaders: TNetHeaders): IHTTPResponse; overload;

C++ 

System::Net::Httpclient::_di_IHTTPResponse __fastcall Delete(const System::UnicodeString AURL, System::Classes::TStream* const AResponseContent = (System::Classes::TStream*)(0x0), const System::Net::Urlclient::TNetHeaders AHeaders = System::DynamicArray<System::Net::Urlclient::TNameValuePair>())/* overload */;
System::Net::Httpclient::_di_IHTTPResponse __fastcall Delete(const System::UnicodeString AURL, System::Classes::TStream* const ASource, System::Classes::TStream* const AResponseContent, const System::Net::Urlclient::TNetHeaders AHeaders)/* 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 using the DELETE 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 Delete 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.

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

See Also

Retrieved from "https://docwiki.embarcadero.com/Libraries/Athens/e/index.php?title=System.Net.HttpClientComponent.TNetHTTPClient.Delete&oldid=709601"