ジャンプ先: 概要. 戻り値. キーワード. フラグ. MEL 例.
displayString [-delete] [-exists] [-keys] [-replace] [-value string] [string][string][string][string]
displayString は、取り消し不可能、照会可能、および編集不可能です。
文字列識別子に文字列値を割り当てます。文字列を 1 箇所で定義し、識別子を使用することで別の位置でも参照できます。フォーマット文字列もサポートしています(注: この機能は format コマンドによって、より一般的な形で提供されるようになりました。format の使用をお勧めします)。最大 3 つの特殊文字シーケンス ^1、^2、^3 を埋め込んで、文字列を自動置換できます。埋め込まれた文字は追加のコマンド引数に置換されます。詳細については、例を参照してください。追加のコマンド引数は、表示文字列識別子である必要はありません。
なし
照会モードでは、戻り値のタイプは照会されたフラグに基づきます。
display, string
delete, exists, keys, replace, value
| ロング ネーム(ショート ネーム) |
引数タイプ |
プロパティ |
-delete(-d)
|
|
|
|
このフラグを使用して、識別子文字列を除去します。識別子が存在しない場合は失敗します。
|
|
-exists(-ex)
|
|
|
|
指定した識別子の存在の有無によって、true か false を返します。
|
|
-keys(-k)
|
|
|
|
識別子文字列に一致するすべての displayString キーをリスト表示します。識別文字列はキー文字列の全体でもその一部でもかまいません。このコマンドは、識別文字列を従属文字列とするすべての識別キーのリストを返します。
|
|
-replace(-r)
|
|
|
|
既存の識別子に新しい値を割り当てようとすると displayString コマンドが失敗するため、既存の識別子の値に対する更新を許可するためには、このフラグが必要です。識別子が存在しない場合は、-replace フラグが存在しないかのように、新しい識別子が追加されます。
|
|
-value(-v)
|
string
|
|
|
表示文字列の値。表示文字列の作成時にこのフラグを指定しない場合、値は識別子と同じになります。
|
|
|
フラグはコマンドの作成モードで表示できます
|
フラグはコマンドの編集モードで表示できます
|
|
フラグはコマンドの照会モードで表示できます
|
コマンド内でフラグを複数回使用できます。
|
// Associate a string with an identifier.
//
displayString -value "Hello world" kExampleHelloWorld;
// Query string associated with an identifer.
//
displayString -query -value kExampleHelloWorld;
// Define a simple formatted string to append ellipses.
//
displayString -value "^1s..." kExampleEllipsesFormat;
displayString -query -value kExampleEllipsesFormat kExampleHelloWorld;
// Define a formatted string using all the available
// embedded characters.
//
displayString -value "These ^1s are ^2s me ^3s" kExampleAnotherFormat;
displayString -value "pretzels" kExamplePretzels;
displayString -query -value kExampleAnotherFormat kExamplePretzels "making" "thirsty";
// Obtain a list of matching displayString keys.
// In the first example a list of all keys containing the substring
// "niceName".
// In the second example a list of all keys in the string set
// m_testStrings
displayString -query -keys "niceName";
displayString -query -keys "m_testStrings.";
// If you don't specify the -v/value flag on creating then
// the value will be the same as the identifier.
//
displayString kExampleMissingValue;
displayString -query -value kExampleMissingValue;
// Delete a string identifer.
//
displayString -delete kExampleHelloWorld;