FREGetObjectProperty()

AIR 3.0 以降

使用方法

FREResult FREGetObjectProperty ( 
                FREObject                 object, 
                const uint8_t*                 propertyName, 
                FREObject*                propertyValue, 
                FREObject*                thrownException 
);

パラメーター

object
プロパティの値を取得する対象となる ActionScript クラスオブジェクトを表す FREObject。

propertyName
uint8_t 配列。この配列にはプロパティの名前を表す文字列が含まれます。この文字列には UTF-8 エンコーディングを使用し、null 文字で終了します。

propertyValue
FREObject へのポインター。このメソッドは、この FREObject パラメーターを、要求されたプロパティである ActionScript オブジェクトを表すように設定します。

thrownException
FREObject へのポインター。このメソッドを呼び出すことによりランタイムが ActionScript 例外をスローした場合、この FREObject 変数は、ActionScript Error オブジェクトまたは Error サブクラスのオブジェクトを表します。エラーが発生しない場合、ランタイムはこの FREObject 変数を無効に設定します。つまり、thrownException FREObject 変数に FREGetObjectType() を実行すると、 FRE_INVALID_OBJECT が返されます。例外情報の処理を行わない場合は、このポインターを NULL に設定できます。

戻り値

FREResult。戻り値には、以下が含まれます(ただし、これらに限定されません)。

FRE_OK
関数が成功し、 propertyValue パラメーターが正しく設定されています。

FRE_ACTIONSCRIPT_ERROR
ActionScript エラーが発生しました。ランタイムは thrownException パラメーターを、ActionScript Error クラスオブジェクトまたは Error サブクラスオブジェクトを表すように設定します。

FRE_ILLEGAL_STATE
拡張コンテキストは既に ActionScript BitmapData または ByteArray オブジェクトを取得しています。この BitmapData または ByteArray オブジェクトを解放するまでは、コンテキストはこのメソッドを呼び出すことはできません。

FRE_INVALID_ARGUMENT
propertyName または propertyValue パラメーターは NULL です。

FRE_INVALID_OBJECT
FREObject パラメーターが無効です。

FRE_NO_SUCH_NAME
propertyName パラメーターは object パラメーターが表す ActionScript クラスオブジェクトのプロパティと一致しません。可能性は低いですが、この戻り値の理由は他にもあります。具体的には、ActionScript クラスに 2 つの同名のプロパティがあるものの、これらが異なる ActionScript 名前空間のものであるという、稀なケースが考えられます。

FRE_TYPE_MISMATCH
FREObject パラメーターは ActionScript クラスオブジェクトを表していません。

FRE_WRONG_THREAD
ランタイムにネイティブ拡張関数に対する未実行の呼び出しがあるスレッドとは別のスレッドから、メソッドが呼び出されました。

説明

object パラメーターで指定した ActionScript クラスオブジェクトの public プロパティに対応するデータを示す FREObject 変数を取得するには、この関数を呼び出します。