Data.Cloud.AmazonAPI.TAmazonStorageService.BuildQueryParameterString

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function BuildQueryParameterString(const QueryPrefix: string; QueryParameters: TStringList;  DoSort: Boolean = False; ForURL: Boolean = True): string; override;

C++

virtual System::UnicodeString __fastcall BuildQueryParameterString(const System::UnicodeString QueryPrefix, System::Classes::TStringList* QueryParameters, bool DoSort = false, bool ForURL = true);

Properties

Type Visibility Source Unit Parent
function protected
Data.Cloud.AmazonAPI.pas
Data.Cloud.AmazonAPI.hpp
Data.Cloud.AmazonAPI TAmazonStorageService

Description

Builds a string representation of the given query parameters and the given prefix.

Data.Cloud.AmazonAPI.TAmazonStorageService.BuildQueryParameterString inherits from Data.Cloud.CloudAPI.TCloudService.BuildQueryParameterString. All content below this line refers to Data.Cloud.CloudAPI.TCloudService.BuildQueryParameterString.

Builds a string representation of the given query parameters and the given prefix.

BuildQueryParameterString returns the string representation of the query parameters.

The parameters list will be lexicographically sorted if DoSort is set to True. The characters used in the query string depend on the value of ForURL. If set to True, '?' will be used after the '=' prefix.

The following table shows the significance of the parameters:

Parameter Description

QueryPrefix

Value to prefix the result string with.

QueryParameters

List of parameters to build the result string from.

DoSort

True to sort the given QueryParameters list, False otherwise.

ForURL

Set to True to use default (URL) characters in the string, False to use the characters specified by FQueryStartChar, FQueryParamKeyValueSeparator, and FQueryParamSeparator.


See Also