REST.Json.TJson.ObjectToJsonString

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

Delphi

class function ObjectToJsonString(AObject: TObject; AOptions: TJsonOptions = [joDateIsUTC, joDateFormatISO8601, joBytesFormatArray, joIndentCaseCamel]): string;

C++

__classmethod System::UnicodeString __fastcall ObjectToJsonString(System::TObject* AObject, TJsonOptions AOptions = (TJsonOptions() << TJsonOption::joDateIsUTC << TJsonOption::joDateFormatISO8601 << TJsonOption::joBytesFormatArray << TJsonOption::joIndentCaseCamel ));

プロパティ

種類 可視性 ソース ユニット
function public
REST.Json.pas
REST.Json.hpp
REST.Json TJson


説明

指定された TObject の下位オブジェクトを表す JSON 文字列を返します。

JSON オプション

ObjectToJsonString では、ObjectToJsonStringAObject のデータをどう解釈し、そのデータを結果の JSON 文字列にどう表現するかを決定する任意指定の一連のオプションAOptions パラメータで受け取ります。

指定可能なすべての JSON オプションについて、次の表で説明します。AOptions にカスタム値を指定しない場合、ObjectToJsonString では joDateIsUTCjoDateFormatISO8601 を使用します。

オプション 説明

joDateFormatISO8601

ISO 8601 標準を使って日時を書式設定します。たとえば、"2014-12-01T13:14:18Z"(2014 年 12 月 1 日 月曜日 13:14:18 UTC)のようになります。

joDateFormatMongo

日時を MongoDB 拡張 JSON として書式設定します。たとえば、{ "$date": "2014-12-01T13:14:18.000+00:00" }(2014 年 12 月 1 日 月曜日 13:14:18 UTC)のようになります。

joDateFormatUnix

日時を UNIX 時間として書式設定します。たとえば、"1417439658"(2014 年 12 月 1 日 月曜日 13:14:18 UTC)のようになります。

joDateIsUTC

AObject 内の時刻データが UTC 時刻標準を使って記述されています。

このオプションを指定しない場合、ObjectToJsonString では、AObject 内の時刻データがお使いのシステムのローカル タイムゾーンを使って記述されていると仮定します。

joIgnoreEmptyArrays

JSON オブジェクトのキーと値のペアは、ペアの値が空の JSON 配列の場合には排除されます。

たとえば、JSON を使って AObject{ "key1": [], "key2": "value2" } とシリアル化できる場合、joIgnoreEmptyArrays オプションが指定されていると、結果として生成される JSON コードは代わりに { "key2": "value2" } となります。

joIgnoreEmptyStrings

JSON オブジェクトのキーと値のペアは、ペアの値が空の文字列の場合には排除されます。

たとえば、JSON を使って AObject{ "key1": "value1", "key2": "" } とシリアル化できる場合、joIgnoreEmptyStrings オプションが指定されていると、結果として生成される JSON コードは代わりに { "key1": "value1" } となります。

joIndentCaseCamel

キーの名前の形式。最初の文字は小文字で、残りは形式を保持します。

たとえば、次のペア { "KeyName": "TextSample" } の場合、joIndentCaseCamel 形式オプションの結果は、{ "keyName": "TextSample" } となります。

joIndentCaseLower

キーの名前の形式。すべての文字が小文字になります。

たとえば、次のペア { "KeyName": "TextSample" } の場合、joIndentCaseLower 形式オプションの結果は、{ "keyname": "TextSample" } となります。

joIndentCaseUpper

キーの名前の形式。すべての文字が大文字になります。

たとえば、次のペア { "KeyName": "TextSample" } の場合、joIndentCaseUpper 形式オプションの結果は、{ "KEYNAME": "TextSample" } となります。

joIndentCasePreserve

キーの名前の形式。文字の大文字小文字は保持されます。

関連項目