FileReference.GetFileInSequence

FileReference.GetFileInSequence

説明

そのファイルシーケンスにおいて、指定されたファイル名の解決されたパスを戻します。

ファイル シーケンスは、「myfile.1.pic」、「myfile.2.pic」など、同じ基本名を持つ複数のファイルです。たとえば、ディスクにレンダリングする場合、[レンダリング オプション]プロパティ ページで指定した基本ファイル名に基づいて Softimage でファイル シーケンスが作成されます。出力フォルダを参照する場合は、「'myfile」などのようにアノテーション付きでファイル シーケンスが単一エンティティとして表示されます。 [1..2]. pic"のようになります。)

C#構文

String FileReference.GetFileInSequence( UInt32 in_iIndex );

スクリプト構文

oString = FileReference.GetFileInSequence( Index );

戻り値

String。そのファイルシーケンスにおける、特定のファイル名の解決されたパス。ファイルがシークエンスに存在しない場合は、インデックス0が解決されたパスが戻されます。それ以外の場合は、0よりも大きいインデックス値およびエラーが戻されます。インデックスが範囲外の場合は、空のパスとエラーが戻されます。

パラメータ

パラメータ タイプ 説明
Index Long ファイルシークエンスでのファイルの位置を指定します。1 で始まるファイルシークエンスであっても、このインデックスは 0 から始まります。たとえば、1 で始まるシークエンスの Myoutput.24.pic を指定する場合、この引数では 23 を指定する必要があります。注：インデックスがシークエンス内のファイル数を上回る場合はエラーが戻されます。

例

JScript の例

NewScene( null, false );

// ---------------------------------------------------------------------------

// 	SETUP

//

// First import a model so we have some external files to find

var FPath = XSIUtils.BuildPath(

	Application.InstallationPath( siFactoryPath ),

	"Data", "XSI_SAMPLES", "Models", "Man_Face.emdl"

);

ImportModel( FPath, null, true );

// ---------------------------------------------------------------------------

// 	USING THE FileReference OBJECT

//

// Get the collection of all external files on the scene

var oScene = Application.ActiveProject.ActiveScene;

var l_extFileList = oScene.ExternalFiles;

// Get the first file object in the list

var oFile = l_extFileList(0);

if ( l_extFileList.NumberOfFilesInSequence > 1 ) {

	// Show the last file in the sequence

	Application.LogMessage( oFile.GetFileInSequence(oFile.NumberOfFilesInSequence-1) );

}

// Expected results:

//INFO : <factory_path>\rsrc\noIcon3.pic

関連項目

FileReference.NumberOfFilesInSequence