Data.Cloud.CloudAPI.TCloudService.IssueOptionsRequest

From RAD Studio API Documentation
Jump to: navigation, search

Delphi 

function IssueOptionsRequest(AURL: string; const AHeaders, AQueryParameters: TStringList; const AQueryPrefix: string;  const AResponseInfo: TCloudResponseInfo): TCloudHTTP; overload; virtual;
function IssueOptionsRequest(AURL: string; const AHeaders, AQueryParameters: TStringList;  const AQueryPrefix: string; const AResponseInfo: TCloudResponseInfo; out AResponseString: string): TCloudHTTP; overload; virtual;

C++ 

virtual TCloudHTTP* __fastcall IssueOptionsRequest(System::UnicodeString AURL, System::Classes::TStringList* const AHeaders, System::Classes::TStringList* const AQueryParameters, const System::UnicodeString AQueryPrefix, TCloudResponseInfo* const AResponseInfo)/* overload */;
virtual TCloudHTTP* __fastcall IssueOptionsRequest(System::UnicodeString AURL, System::Classes::TStringList* const AHeaders, System::Classes::TStringList* const AQueryParameters, const System::UnicodeString AQueryPrefix, TCloudResponseInfo* const AResponseInfo, /* out */ System::UnicodeString &AResponseString)/* overload */;

Properties

Type Visibility Source Unit Parent
function protected
Data.Cloud.CloudAPI.pas
Data.Cloud.CloudAPI.hpp
 Data.Cloud.CloudAPI TCloudService

Description

Sends a request using the OPTIONS HTTP method, and returns the instance of TCloudHTTP that it uses to send the request.

IssueOptionsRequest receives the following parameters:

  • AURL is the target URL.
  • AHeaders defines key-value pairs to include in the request. If your request needs authentication, you must use this parameter to specify the required authentication headers.
  • AQueryParameters defines key-value pairs to include in the request as URL query parameters. If your request needs authentication, you must use this parameter to specify the required authentication URL query parameters.
  • AQueryPrefix is a prefix to append at the beginning of the query string when building the string to sign.
  • AResponseInfo is an optional instance of TCloudResponseInfo to store the information of the response. Use a nil value if you do not need the information of the response.
  • AResponseString is an optional output variable that IssueOptionsRequest fills with the content of the response as a string.

See Also

Retrieved from "http://docwiki.embarcadero.com/Libraries/Sydney/e/index.php?title=Data.Cloud.CloudAPI.TCloudService.IssueOptionsRequest&oldid=748902"