Grabber::loadDeviceState Method

構文

bool loadDeviceState( const std::string& xmlStr, bool bOpenDev = true );
bool loadDeviceState( const std::wstring& xmlStr, bool bOpenDev = true );
パラメータ 説明
xmlStr 設定を保持する文字列を指定します。この文字列はsaveDeviceStateを呼び出すことで取得できます。
bOpenDev パラメータがtrueにセットされるとメソッドが設定データによって指定されるデバイスをオープンな状態にします。パラメータがfalseの場合には行いません。しかしその設定データはすでにオープンな状態のデバイスに適用されます。

戻り値

プデバイス状態が正常にロードされた場合にはtrueを返します。
エラーが発生した場合にはgetLastErrorクラスライブラリリファレンス>クラス>Grabber>Grabber::getLastError Methodをコールしてエラーコードを取得することができます。xmlStr内できちんと形成されなかったXML データはエラー値をeINVALID_PARAM_VALに設定します。もしそのデータがこのバージョンのIC Imaging Controlに対応しない場合のエラーコードは eINCOMPATIBLE_VERSIONとなります。eINCOMPLETEはいくつかのプロパティにおいてデータ型文字列内の値で初期化することができなかったというのを報告するものです。

備考

パラメータbOpenDevがtrueであった場合、 設定データ内に格納された名前とシリアル番号によって指定されるデバイスをオープンにします。falseの時にはその設定だけがすでにオープンな状態のデバイスに適用されます。その際に設定が適用されるデバイスは設定を保存したデバイスと同じ種類のものである必要があります。

インフォメーション

IC Imaging Control 2.0より導入。

サンプル

デバイスの状態の保存と呼び出しについてはsaveDeviceStateクラスライブラリリファレンス>クラス>Grabber>Grabber::saveDeviceState Methodを参照してください。