ImageComparison オブジェクト

このオブジェクトは、バイナリファイル比較ウィンドウを表します。ウィンドウは画面に表示されないことがあります。このウィンドウを使って、クライアントにファイル比較サービスを実行したり、ユーザーにファイル比較画面を表示することができます。

このオブジェクトが公開するメソッドとプロパティを使って、バイナリファイル比較とバイナリファイル比較ウィンドウの外観の変更を行います。

プロパティ (ICommonUI インターフェイスによって実装されます )

Active

IDL	`[propget] HRESULT Active([out, retval] VARIANT_BOOL* pValue) [propput] HRESULT Active([in] VARIANT_BOOL newValue)`
.NET	`Boolean Active[get, set]`
VB6	`Active As Boolean`

比較ウィンドウの作業状態。

このプロパティは取得と設定が可能です。

Height

IDL	`[propget] HRESULT Height([out, retval] long* pValue) [propput] HRESULT Height([in] long newValue)`
.NET	`Int32 Height[get, set]`
VB6	`Height As Long`

比較ウィンドウの高さ（ピクセル）。

このプロパティは取得と設定が可能です。

Left

IDL	`[propget] HRESULT Left([out, retval] long* pValue) [propput] HRESULT Left([in] long newValue)`
.NET	`Int32 Left[get, set]`
VB6	`Left As Long`

比較ウィンドウの左端のピクセル座標の位置。

このプロパティは取得と設定が可能です。

Maximized

IDL	`[propget] HRESULT Maximized([out, retval] VARIANT_BOOL* pValue) [propput] HRESULT Maximized([in] VARIANT_BOOL newValue)`
.NET	`Boolean Maximized[get, set]`
VB6	`Maximized As Boolean`

比較ウィンドウの最大化状態。

このプロパティは取得と設定が可能です。

Minimized

IDL	`[propget] HRESULT Minimized([out, retval] VARIANT_BOOL* pValue) [propput] HRESULT Minimized([in] VARIANT_BOOL newValue)`
.NET	`Boolean Minimized[get, set]`
VB6	`Minimized As Boolean`

比較ウィンドウの最小化状態。

このプロパティは取得と設定が可能です。

Top

IDL	`[propget] HRESULT Top([out, retval] long* pValue) [propput] HRESULT Top([in] long newValue)`
.NET	`Int32 Top[get, set]`
VB6	`Top As Long`

比較ウィンドウの上端のピクセル座標の位置。

このプロパティは取得と設定が可能です。

Visible

IDL	`[propget] HRESULT Visible([out, retval] VARIANT_BOOL* pValue) [propput] HRESULT Visible([in] VARIANT_BOOL newValue)`
.NET	`Boolean Visible[get, set]`
VB6	`Visible As Boolean`

比較ウィンドウの表示状態。

このプロパティは取得と設定が可能です。

Width

IDL	`[propget] HRESULT Width([out, retval] long* pValue) [propput] HRESULT Width([in] long newValue)`
.NET	`Int32 Width[get, set]`
VB6	`Width As Long`

比較ウィンドウの幅（ピクセル）。

このプロパティは取得と設定が可能です。

プロパティ (IComparison インターフェイスによって実装されます )

ViewType

IDL	`[propget] HRESULT ViewType([out, retval] FileViewType* pValue) [propput] HRESULT ViewType([in] FileViewType newValue)`
.NET	`FileViewType ViewType[get, set]`
VB6	`ViewType As FileViewType`

比較タイプ（2 者間または 3 者間レイアウト）。

このプロパティは取得と設定が可能です。

プロパティ (IFileComparison インターフェイスによって実装されます )

AllUnresolvedConflicts

IDL	`[propget] HRESULT AllUnresolvedConflicts([out, retval] long* pValue)`
.NET	`Int32 AllUnresolvedConflicts[get]`
VB6	`AllUnresolvedConflicts As Long`

現在は使用されていません。

このプロパティは取得のみです。

AutoSaveOnClose

IDL	`[propget] HRESULT AutoSaveOnClose([out, retval] VARIANT_BOOL* pValue) [propput] HRESULT AutoSaveOnClose([in] VARIANT_BOOL newValue)`
.NET	`Boolean AutoSaveOnClose[get, set]`
VB6	`AutoSaveOnClose As Boolean`

現在は使用されていません。

このプロパティは取得と設定が可能です。

ComparisonError

IDL	`[propget] HRESULT ComparisonError([in, optional] VARIANT nFilePair, [out, retval] FileComparisonError* pValue)`
.NET	`FileComparisonError get_ComparisonError(Object nFilePair)`
VB6	`ComparisonError( [nFilePair As Variant]) As FileComparisonError`

Compare メソッドで発生するエラー。

このプロパティは取得のみです。

引数

nFilePair [optional]
ファイル 0 と 1 の結果を返すか（nFilePair = 0［デフォルト］の場合）、ファイル 1 と 2 の結果を返すか（nFilePair = 1 の場合）を指定します。

ComparisonResult

IDL	`[propget] HRESULT ComparisonResult([in, optional] VARIANT nFilePair, [out, retval] FileComparisonResult* pValue)`
.NET	`FileComparisonResult get_ComparisonResult(Object nFilePair)`
VB6	`ComparisonResult( [nFilePair As Variant]) As FileComparisonResult`

Compare メソッドで実行する比較の結果（fcrSame、fcrDifferent、fcrError）。

このプロパティは取得のみです。

引数

nFilePair [optional]
ファイル 0 と 1 の結果を返すか（nFilePair = 0［デフォルト］の場合）、ファイル 1 と 2 の結果を返すか（nFilePair = 1 の場合）を指定します。

ErrorInfo

IDL	`[propget] HRESULT ErrorInfo([in] short nFile, [out, retval] BSTR* pValue) [propput] HRESULT ErrorInfo([in] short nFile, [in] BSTR newValue)`
.NET	`String get_ErrorInfo(Int16 nFile) void set_ErrorInfo(Int16 nFile, String newValue)`
VB6	`ErrorInfo(nFile As Integer) As String`

ファイルの 1 つを読み込み/比較している間に発生したエラーに関する詳細情報を提供します。 nFile が -1 の場合、3 つのファイルすべてに適用されるエラー（メモリ不足エラーなど）が返されます。

このプロパティは取得と設定が可能です。

引数

nFile
エラー情報を取得するファイル（0、1 または 2）。値を -1 にするとすべてのファイルを指定することもできます。

Modified

IDL	`[propget] HRESULT Modified([in] short nFile, [out, retval] VARIANT_BOOL* pValue) [propput] HRESULT Modified([in] short nFile, [in] VARIANT_BOOL newValue)`
.NET	`Boolean get_Modified(Int16 nFile) void set_Modified(Int16 nFile, Boolean newValue)`
VB6	`Modified(nFile As Integer) As Boolean`

現在は使用されていません。

このプロパティは取得と設定が可能です。

引数

nFile

NumberOfChanges

IDL	`[propget] HRESULT NumberOfChanges([in, optional] VARIANT nFilePair, [out, retval] long* pValue)`
.NET	`Int32 get_NumberOfChanges(Object nFilePair)`
VB6	`NumberOfChanges( [nFilePair As Variant]) As Long`

2 つのファイル間の変更数。

このプロパティは取得のみです。

引数

nFilePair [optional]
ファイル 0 と 1 の結果を返すか（nFilePair = 0［デフォルト］の場合）、ファイル 1 と 2 の結果を返すか（nFilePair = 1 の場合）を指定します。

PromptForUnsavedFiles

IDL	`[propget] HRESULT PromptForUnsavedFiles([out, retval] VARIANT_BOOL* pValue) [propput] HRESULT PromptForUnsavedFiles([in] VARIANT_BOOL newValue)`
.NET	`Boolean PromptForUnsavedFiles[get, set]`
VB6	`PromptForUnsavedFiles As Boolean`

現在は使用されていません。

このプロパティは取得と設定が可能です。

ReadOnly

IDL	`[propget] HRESULT ReadOnly([in] short nFile, [out, retval] VARIANT_BOOL* pValue) [propput] HRESULT ReadOnly([in] short nFile, [in] VARIANT_BOOL newValue)`
.NET	`Boolean get_ReadOnly(Int16 nFile) void set_ReadOnly(Int16 nFile, Boolean newValue)`
VB6	`ReadOnly(nFile As Integer) As Boolean`

現在は使用されていません。

このプロパティは取得と設定が可能です。

引数

nFile

SaveFileName

IDL	`[propget] HRESULT SaveFileName([out, retval] BSTR* pValue) [propput] HRESULT SaveFileName([in] BSTR newValue)`
.NET	`String SaveFileName[get, set]`
VB6	`SaveFileName As String`

現在は使用されていません。

このプロパティは取得と設定が可能です。

ThreeWayMergeActions

IDL	`[propget] HRESULT ThreeWayMergeActions([out, retval] IThreeWayMergeActions** pValue)`
.NET	`ThreeWayMergeActions ThreeWayMergeActions[get]`
VB6	`ThreeWayMergeActions As ThreeWayMergeActions`

現在は使用されていません。

このプロパティは取得のみです。

UnresolvedConflicts

IDL	`[propget] HRESULT UnresolvedConflicts([in] short nFile, [out, retval] long* pValue)`
.NET	`Int32 get_UnresolvedConflicts(Int16 nFile)`
VB6	`UnresolvedConflicts(nFile As Integer) As Long`

現在は使用されていません。

このプロパティは取得のみです。

引数

nFile

プロパティ (IImageComparison インターフェイスによって実装されます )

メソッド (ICommonUI インターフェイスによって実装されます )

Close

IDL	`HRESULT Close()`
.NET	`void Close()`
VB6	`Close`

比較ウィンドウを閉じます。

GiveUserControl

IDL	`HRESULT GiveUserControl()`
.NET	`void GiveUserControl()`
VB6	`GiveUserControl`

比較ウィンドウの起動から終了までをユーザーが制御できるようにします。未処理のオートメーション参照が解放されても、Merge は自動的に比較ウィンドウを閉じません。

Restore

IDL	`HRESULT Restore()`
.NET	`void Restore()`
VB6	`Restore`

比較ウィンドウを最小化または最大化された状態から通常のサイズ変更可能な状態に戻します。

メソッド (IComparison インターフェイスによって実装されます )

Compare

IDL	`HRESULT Compare([in] VARIANT strFirstFile, [in] VARIANT strSecondFile, [in, optional] VARIANT strThirdFile)`
.NET	`void Compare(Object strFirstFile, Object strSecondFile, Object strThirdFile)`
VB6	`Compare(strFirstFile As Variant, strSecondFile As Variant [, strThirdFile As Variant])`

2 つまたは 3 つのファイルを比較します。このメソッドは同期メソッドです。比較が完了して、エラーと結果を報告するときに、ComparisonComplete イベントが発生します。

引数

strFirstFile
第 1 ファイルへの完全修飾パス。
strSecondFile
第 2 ファイルへの完全修飾パス。
strThirdFile [optional]
第 3 ファイルへの完全修飾パス。

Print

IDL	`HRESULT Print([in] VARIANT_BOOL bShowPrinterDialog, [in] PageOrientation nOrientation)`
.NET	`void Print(Boolean bShowPrinterDialog, PageOrientation nOrientation)`
VB6	`Print(bShowPrinterDialog As Boolean, nOrientation As PageOrientation)`

ファイル比較を印刷します。

引数

bShowPrinterDialog
デフォルトは FALSE です。印刷を行う前に印刷ダイアログをユーザーに表示するかどうか。
nOrientation
デフォルトは poLandscape です。印刷の向きを縦置き、横置きのどちらで印刷するか。

Refresh

IDL	`HRESULT Refresh()`
.NET	`void Refresh()`
VB6	`Refresh`

ウィンドウに表示されているファイルを再度比較します。これにより、未保存の変更は破棄されます。

Report

IDL	`HRESULT Report([in] BSTR bstrReporter, [in] LineEndingStyle nLineEndingStyle, [in] BSTR strOutputFile)`
.NET	`void Report(String bstrReporter, LineEndingStyle nLineEndingStyle, String strOutputFile)`
VB6	`Report(bstrReporter As String, nLineEndingStyle As LineEndingStyle, strOutputFile As String)`

現在は使用されていません。

引数

bstrReporter
nLineEndingStyle
strOutputFile

Report2

IDL	`HRESULT Report2([in] BSTR bstrReporter, [in] LineEndingStyle nLineEndingStyle, [in] VARIANT vtEncoding, [in] BSTR strOutputFile)`
.NET	`void Report2(String bstrReporter, LineEndingStyle nLineEndingStyle, Object vtEncoding, String strOutputFile)`
VB6	`Report2(bstrReporter As String, nLineEndingStyle As LineEndingStyle, vtEncoding As Variant, strOutputFile As String)`

現在は使用されていません。

引数

bstrReporter
nLineEndingStyle
vtEncoding
strOutputFile

SaveComparison

IDL	`HRESULT SaveComparison([in] BSTR filename)`
.NET	`void SaveComparison(String filename)`
VB6	`SaveComparison(filename As String)`

比較をファイルに保存します。ファイル名には .cmp7 拡張子を使用することをお勧めします。

引数

filename
比較を保存するファイルの名前。

SetPanelTitles

IDL	`HRESULT SetPanelTitles([in] VARIANT strFirst, [in] VARIANT strSecond, [in, optional] VARIANT strThird)`
.NET	`void SetPanelTitles(Object strFirst, Object strSecond, Object strThird)`
VB6	`SetPanelTitles(strFirst As Variant, strSecond As Variant [, strThird As Variant])`

ファイルパネルの上に表示するタイトルを設定します。

引数

strFirst
第 1 ファイルパネルのタイトル。
strSecond
第 2 ファイルパネルのタイトル。
strThird [optional]
第 3 ファイルパネルのタイトル。

メソッド (IFileComparison インターフェイスによって実装されます )

CompareAsync

IDL	`HRESULT CompareAsync([in] VARIANT strFirstFile, [in] VARIANT strSecondFile, [in, optional] VARIANT strThirdFile)`
.NET	`void CompareAsync(Object strFirstFile, Object strSecondFile, Object strThirdFile)`
VB6	`CompareAsync(strFirstFile As Variant, strSecondFile As Variant [, strThirdFile As Variant])`

2 つまたは 3 つのファイルを比較します。このメソッドは非同期メソッドです（比較が完了する前に返されます）。比較が完了して、エラーと結果を報告するときに、ComparisonComplete イベントが発生します。

引数

strFirstFile
第 1 ファイルへの完全修飾パス。
strSecondFile
第 2 ファイルへの完全修飾パス。
strThirdFile [optional]
第 3 ファイルへの完全修飾パス。

SaveFile

IDL	`HRESULT SaveFile([in] short nFile, [in, optional] VARIANT strSaveTo)`
.NET	`void SaveFile(Int16 nFile, Object strSaveTo)`
VB6	`SaveFile(nFile As Integer [, strSaveTo As Variant])`

現在は使用されていません。

引数

nFile
strSaveTo [optional]

SaveFileAs

IDL	`HRESULT SaveFileAs([in] short nFile)`
.NET	`void SaveFileAs(Int16 nFile)`
VB6	`SaveFileAs(nFile As Integer)`

現在は使用されていません。

引数

nFile

ThreeWayMerge

IDL	`HRESULT ThreeWayMerge([out, retval] long* pValue)`
.NET	`Int32 ThreeWayMerge()`
VB6	`ThreeWayMerge As Long`

現在は使用されていません。

メソッド (IImageComparison インターフェイスによって実装されます )

イベント (IFileComparisonEvents インターフェイスによって実装されます )

Close

IDL	`HRESULT Close()`
.NET	`void Close()`
VB6	`Close`

ファイル比較ウィンドウはユーザーが閉じます。

ComparisonComplete

IDL	`HRESULT ComparisonComplete([in] FileComparisonError error1, [in] FileComparisonResult result1, [in, optional] FileComparisonError error2, [in, optional] FileComparisonResult result2)`
.NET	`void ComparisonComplete(FileComparisonError error1, FileComparisonResult result1, FileComparisonError error2, FileComparisonResult result2)`
VB6	`ComparisonComplete(error1 As FileComparisonError, result1 As FileComparisonResult [, error2 As FileComparisonError] [, result2 As FileComparisonResult])`

ファイル比較が完了したときに発生します。2 つのファイルを比較する場合、最初の 2 つの引数のみが定義されます。3 つのファイルを比較する場合は、4 つすべての引数が定義されます。

引数

error1
第 1 ファイルと第 2 ファイルの比較中に発生したエラー（ある場合）。
result1
第 1 ファイルと第 2 ファイルとの比較の結果。
error2 [optional]
第 2 ファイルと第 3 ファイルの比較中に発生したエラー（ある場合）。
result2 [optional]
第 2 ファイルと第 3 ファイルとの比較の結果。

関連するトピック
オートメーション API