REST.Client.TCustomRESTRequest.AddParameter

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

procedure AddParameter(const AName, AValue: string); overload;
procedure AddParameter(const AName: string; AJsonObject: TJSONObject; AFreeJson: boolean = True); overload;
procedure AddParameter(const AName: string; AJsonObject: TJSONObject; AOwnsObject: TRESTObjectOwnership {= ooREST}); overload;
procedure AddParameter(const AName, AValue: string; const AKind: TRESTRequestParameterKind); overload;
procedure AddParameter(const AName, AValue: string; const AKind: TRESTRequestParameterKind;  const AOptions: TRESTRequestParameterOptions); overload;

C++

void __fastcall AddParameter(const System::UnicodeString AName, const System::UnicodeString AValue)/* overload */;
void __fastcall AddParameter(const System::UnicodeString AName, System::Json::TJSONObject* AJsonObject, bool AFreeJson = true)/* overload */;
void __fastcall AddParameter(const System::UnicodeString AName, System::Json::TJSONObject* AJsonObject, Rest::Types::TRESTObjectOwnership AOwnsObject)/* overload */;
void __fastcall AddParameter(const System::UnicodeString AName, const System::UnicodeString AValue, const Rest::Types::TRESTRequestParameterKind AKind)/* overload */;
void __fastcall AddParameter(const System::UnicodeString AName, const System::UnicodeString AValue, const Rest::Types::TRESTRequestParameterKind AKind, const Rest::Types::TRESTRequestParameterOptions AOptions)/* overload */;

プロパティ

種類 可視性 ソース ユニット
procedure
function
public
REST.Client.pas
REST.Client.hpp
REST.Client TCustomRESTRequest


説明

要求に HTTP パラメータを追加します。同じ名前のパラメータが既に存在する場合、このメソッドでは既存のパラメータを上書きします。

このメソッドは、次のようにオーバーロード(多重定義)されています。

  • AddParameter の第 1 のオーバーロード メソッドでは、名前と値で指定された新しいパラメータを追加します。このメソッドに指定されるパラメータは次のとおりです。
    • AName -- パラメータ名を指定します。
    • AValue -- パラメータ値を指定します。
  • AddParameter の第 2 のオーバーロード メソッドでは、要求に JSON 形式の HTTP パラメータを追加します。このメソッドに指定されるパラメータは次のとおりです。
    • AName -- パラメータ名を指定します。
    • AJsonObject -- パラメータ値を JSON オブジェクトの形式で指定します。
    • AFreeJson -- これが True の場合、AJsonObject パラメータで指定されたオブジェクトは自動的に解放されます。
  • AddParameter の第 3 のオーバーロード メソッドでは、パラメータの種類も引数として受け取り、新しい HTTP パラメータを要求に追加します。このメソッドに指定されるパラメータは次のとおりです。
    • AName -- パラメータ名を指定します。
    • AValue -- パラメータ値を指定します。
    • AKind -- パラメータの種類を指定します。
  • AddParameter の第 4 のオーバーロード メソッドでは、パラメータの種類とオプションも引数として受け取り、新しい HTTP パラメータを要求に追加します。このメソッドに指定されるパラメータは次のとおりです。

関連項目