インタフェース: CustomFileStream

3ds Max 2019 の 新機能: CustomFileStream インタフェースは、外部シーン ファイルから CustomFileStream をクエリ、追加、変更、および削除する場合に使用します。現在のシーン ファイル内の CustomFileStream は、CustomSceneStreamManager インタフェースで管理されます。概要トピック「カスタム ファイル ストリーム」を参照してください。

使用可能な定義済みのフラグ値およびカスタマイズ可能な「パブリック」フラグ値の詳細については、「CustomSceneStreamManager」を参照してください。

インタフェース > コア インタフェース > CustomFileStream

コア インタフェース - クイック ナビゲーション

メソッド:

<TSTR by value array>getStreamNames
	<filename>fileName

指定したファイル内の CustomFileStream 名の配列を返します。指定したファイルが存在しない場合、またはカスタム ファイル ストリーム ストレージがサポートされていない場合(たとえば、3ds Max 2019 より前のバージョンのファイルがある場合)は、例外が発生します。

<bool>doesStreamExist <filename>fileName
	<string>streamName

指定した CustomFileStream が指定したファイル内に存在する場合は、true を返します。指定したファイルが存在しない場合、またはカスタム ファイル ストリーム ストレージがサポートされていない場合は、例外が発生します。

<bool> isCustomFileStreamOperable
	<filename>fileName <string>streamName

指定したファイル内の指定したストリームが有効な CustomFileStream である場合は、true を返します。指定したファイルが存在しない場合、カスタム ファイル ストリーム ストレージがサポートされていない場合、または指定したストリームが存在しない場合は、例外が発生します。このメソッドの主な用途は、外部アプリケーションで記述された CustomFileStream が有効であるかどうかをテストすることです。

<bool>deleteStream <filename>fileName
	<string>streamName

指定したファイル内の指定した CustomFileStream を削除します。ファイルが存在するにもかかわらず、書き込みアクセス権で開くことができない場合は、false を返します。指定したファイルが存在しない場合、カスタム ファイル ストリーム ストレージがサポートされていない場合、または指定した CustomFileStream が存在しない場合は、例外が発生します。

<TSTR by value>readStream <filename>fileName
	<string>streamName

指定したファイル内の指定した CustomFileStream の内容を文字列として返します。内容が文字列の配列である場合は、最初の文字列が返されます。指定したファイルが存在しない場合、カスタム ファイル ストリーム ストレージがサポートされていない場合、または指定した CustomFileStream が存在しない場合は、例外が発生します。

<bool>writeStream <filename>fileName
	<string>streamName <string>content
	persistent:<bool> noLoadOnSceneLoad:<bool>
	append:<bool>
	persistent default value: true
	noLoadOnSceneLoad default value: false
	append default value: false

指定したファイル内に指定した CustomFileStream を作成して、その内容を指定した文字列に設定します。新しいストリームの場合は、対応するフラグ値を設定します。ストリームが既に存在する場合は、内容が置き換えられます。ただし、append:true を指定して、指定した文字列を現在の内容に追加する場合は除きます。ファイルが存在するにもかかわらず、書き込みアクセス権で開くことができない場合は、false を返します。指定したファイルが存在しない場合、またはカスタム ファイル ストリーム ストレージがサポートされていない場合は、例外が発生します。内容を追加したときに、ストリームに既存の配列の内容が含まれている場合は、例外が発生します。

<TSTR by value array>readStreamArray
	<filename>fileName <string>streamName

指定したファイル内の指定した CustomFileStream の内容を文字列の配列として返します。内容が単一文字列の場合は、1 要素の配列が返されます。指定したファイルが存在しない場合、カスタム ファイル ストリーム ストレージがサポートされていない場合、または指定した CustomFileStream が存在しない場合は、例外が発生します。

<bool>writeStreamArray <filename>fileName
	<string>streamName <string by value array>contentArray
	persistent:<bool> noLoadOnSceneLoad:<bool>
	append:<bool>
	persistent default value: true
	noLoadOnSceneLoad default value: false
	append default value: false

指定したファイル内に指定した CustomFileStream を作成して、その内容を指定した文字列の配列に設定します。内容が新しいストリームの場合は、対応するプライベート フラグ値を設定します。ストリームが既に存在する場合は、内容が置き換えられます。ただし、append:true を指定して、指定した文字列の配列を現在の内容に追加する場合は除きます。ファイルが存在するにもかかわらず、書き込みアクセス権で開くことができない場合は、false を返します。指定したファイルが存在しない場合、またはカスタム ファイル ストリーム ストレージがサポートされていない場合は、例外が発生します。内容を追加したときに、ストリームに既存の文字列の内容(配列ではない)が含まれている場合は、例外が発生します。

<DWORD>getStreamFlags <filename>fileName
	<string>streamName getPrivate:<bool>
	getPrivate default value: false

指定したファイル内の指定した CustomFileStream のフラグ値を返します。指定したファイルが存在しない場合、カスタム ファイル ストリーム ストレージがサポートされていない場合、または指定した CustomFileStream が存在しない場合は、例外が発生します。

<bool>setStreamFlags <filename>fileName
	<string>streamName <DWORD>flags
	setPrivate:<bool>
	setPrivate default value: false

指定したファイル内の指定した CustomFileStream のフラグ値を設定します。ファイルが存在するにもかかわらず、書き込みアクセス権で開くことができない場合は、false を返します。指定したファイルが存在しない場合、カスタム ファイル ストリーム ストレージがサポートされていない場合、または指定した CustomFileStream が存在しない場合は、例外が発生します。

<bool>isStreamDataAnArray <filename>fileName
	<string>streamName

指定したファイル内の指定した CustomFileStream の内容が文字列の配列である場合は、 true を返します。指定したファイルが存在しない場合、カスタム ファイル ストリーム ストレージがサポートされていない場合、または指定した CustomFileStream が存在しない場合は、例外が発生します。