XSIUtils.ResolveTokenString

導入

v6.01

説明

指定された時点でトークン(角括弧で囲まれた語)文字列を解決します。 トークンには次の 2 種類のクラスがあります:

- ユニバーサル: [プロジェクト]、[シーン]、[日付]、[時間]、[フレーム]、[フィールド]、[ユーザ]、[ホスト]、[環境]、および[値]

- コンテキスト固有: 例えば、ユニバーサルではなくレンダリング固有の[パス]トークン

すべての組込みトークンの一覧については、Softimage ユーザ ガイドの「トークンおよびテンプレート」セクションを参照してください。

この呼び出しはユニバーサル トークンの認識のみを行うことに注意してください。既存のコンテキスト固有のトークンが必要な場合、ユーザ定義のトークンとして提供される必要があります。

ユーザ定義トークンを指定するには、トークン名を表す配列と、トークン文字列を解決するために使用される UserTokenNames および UserTokenValues 引数の値を渡します。2 つの文字列の配列は同じサイズである必要があります。

スクリプト 構文

oString = XSIUtils.ResolveTokenString( TokenString, Time, Verbose, [UserTokenNames], [UserTokenValues] );

戻り値

String

パラメータ

パラメータ タイプ 詳細
TokenString String トークンを含む入力文字列
時間 Variant 時間依存のトークンを解決するのに使用される時間
Verbose Boolean True の場合は、エラーメッセージのログが記録されます。
UserTokenNames Variant ユーザのトークン名を表す任意の文字列のArray
UserTokenValues Variant ユーザのトークン値を表す任意の文字列のArray

C#の例

// This example shows how to resolve token strings. 
object[] tokenNames = new object[2] { "A", "C"};
object[] tokenValues = new object[2] { "AAA", "CCC" };
// Note that the Log method used below is provided by the Softimage wizards
Log( "Resolve using default tokens= " + GetUtils().ResolveTokenString("[A][C][Project]", 0, false, null, null) );
Log( "Resolve using default and user tokens= " + GetUtils().ResolveTokenString("[A][C][Project]", 0, false, tokenNames, tokenValues) );