FolderComparison オブジェクト

このオブジェクトは Merge フォルダー比較ウィンドウを表します。必ずしも画面にウィンドウを表示する必要はありませんが、クライアントにフォルダー比較サービスを実行したり、フォルダー比較画面をユーザーに提示したりする場合に、このウィンドウを利用できます。

このオブジェクトが公開するメソッドとプロパティを使って、フォルダー比較、結果の抽出、フォルダー比較ウィンドウの外観の変更を行います。

プロパティ (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 者間レイアウト）。

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

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

Busy

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

比較ウィンドウが、フォルダー比較または再テスト操作でビジー状態かどうか。

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

FileName

IDL	`[propget] HRESULT FileName([in] long nIndex, [in] short nFolder, [out, retval] BSTR* pValue)`
.NET	`String get_FileName(Int32 nIndex, Int16 nFolder)`
VB6	`FileName(nIndex As Long, nFolder As Integer) As String`

比較結果の指定されたインデックスと列にあるファイルの名前。

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

引数

nIndex
比較結果へのインデックス（0 ベース）。NumberOfEntries も参照してください。
nFolder
結果行を含んでいるフォルダー（0、1 または 2）。

FilePath

IDL	`[propget] HRESULT FilePath([in] long nIndex, [in] short nFolder, [out, retval] BSTR* pValue)`
.NET	`String get_FilePath(Int32 nIndex, Int16 nFolder)`
VB6	`FilePath(nIndex As Long, nFolder As Integer) As String`

比較結果の指定されたインデックスと列にあるファイルのパスと名前。

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

引数

nIndex
比較結果へのインデックス（0 ベース）。NumberOfEntries も参照してください。
nFolder
結果行を含んでいるフォルダー（0、1 または 2）。

FileType

IDL	`[propget] HRESULT FileType([in] long nIndex, [out, retval] FolderFileType* pValue)`
.NET	`FolderFileType get_FileType(Int32 nIndex)`
VB6	`FileType(nIndex As Long) As FolderFileType`

比較結果の指定されたインデックスにあるファイルのタイプ。

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

引数

nIndex
比較結果へのインデックス（0 ベース）。NumberOfEntries も参照してください。

Folder

IDL	`[propget] HRESULT Folder([in] short nFolder, [out, retval] BSTR* pValue) [propput] HRESULT Folder([in] short nFolder, [in] BSTR newValue)`
.NET	`String get_Folder(Int16 nFolder) void set_Folder(Int16 nFolder, String newValue)`
VB6	`Folder(nFolder As Integer) As String`

比較する指定フォルダーへの完全修飾パス。

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

引数

nFolder
結果行を含んでいるフォルダー（0、1 または 2）。

FullFilePath

IDL	`[propget] HRESULT FullFilePath([in] long nIndex, [in] short nFolder, [out, retval] BSTR* pValue)`
.NET	`String get_FullFilePath(Int32 nIndex, Int16 nFolder)`
VB6	`FullFilePath(nIndex As Long, nFolder As Integer) As String`

比較結果の指定されたインデックスと列にあるファイルの完全修飾パスと名前。

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

引数

nIndex
比較結果へのインデックス（0 ベース）。NumberOfEntries も参照してください。
nFolder
結果行を含んでいるフォルダー（0、1 または 2）。

NumberOfEntries

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

比較結果の項目数。比較結果には、フォルダー比較ウィンドウでユーザーに表示されるのと同じ順序で項目が含まれます。

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

NumberOfSelectedItems

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

比較結果で選択された項目の数。

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

Selected

IDL	`[propget] HRESULT Selected([in] long nIndex, [out, retval] VARIANT_BOOL* pValue) [propput] HRESULT Selected([in] long nIndex, [in] VARIANT_BOOL newValue)`
.NET	`Boolean get_Selected(Int32 nIndex) void set_Selected(Int32 nIndex, Boolean newValue)`
VB6	`Selected(nIndex As Long) As Boolean`

比較結果の指定されたインデックスにあるファイルが選択されているかどうかを示します。

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

引数

nIndex
比較結果へのインデックス（0 ベース）。NumberOfEntries も参照してください。

メソッド (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 strFirst, [in] VARIANT strSecond, [in, optional] VARIANT strThird)`
.NET	`void Compare(Object strFirst, Object strSecond, Object strThird)`
VB6	`Compare(strFirst As Variant, strSecond As Variant [, strThird As Variant])`

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

引数

strFirst
第 1 フォルダーへの完全修飾パス。
strSecond
第 2 フォルダーへの完全修飾パス。
strThird [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
レポートの生成に使用するレポーターのショートネーム。有効なショートネームは "xml" と "html" です。すべてのレポーターで 3 者間比較レポートの生成がサポートされているわけではありません。
nLineEndingStyle
生成するレポートファイルで使用する行終端のタイプ。
strOutputFile
レポート用の出力ファイルの名前。レポーターが 2 つ以上のファイルを生成する場合、それらのファイルにはこの名前を基にした名前が付けられます。

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
レポートの生成に使用するレポーターのショートネーム。有効なショートネームは "xml" と "html" です。すべてのレポーターで 3 者間比較レポートの生成がサポートされているわけではありません。
nLineEndingStyle
生成するレポートファイルで使用する行終端のタイプ。
vtEncoding
生成するレポートで使用する文字エンコード。コードページ番号、または 'UCS2' （Unicode UCS2）、'UCS2-BE' （Unicode UCS2 ビッグエンディアン）、'UTF8' （Unicode UTF8 バイト順マーク付き）、'UTF8-NOBOM' （Unicode UTF8 バイト順マークなし）、'UTF7' （Unicode UTF7）のいずれか。
strOutputFile
レポート用の出力ファイルの名前。レポーターが 2 つ以上のファイルを生成する場合、それらのファイルにはこの名前を基にした名前が付けられます。

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 フォルダー列のタイトル。

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

CompareSelected

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

比較リストで選択したファイルのファイル比較ウィンドウを開きます。

DeselectAll

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

比較リストでのすべてのファイルの選択を取り消します。

HideEmptyFolders

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

変更、挿入あるいは削除ファイルが含まれないフォルダーを隠します。

Restore

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

フォルダー比較ウィンドウを元に戻します（最小化または最大化を取り消します）。

RetestSelected

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

比較リストで選択したファイルを再テストします。

SelectAll

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

比較結果内のすべてのファイルを選択します。

SelectChanged

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

比較結果内の変更されたすべてのファイルを選択します。

Stop

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

実行中の比較、再テストまたは更新を停止します。

ThreeWayMerge

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

3 者間比較で 2 つの（左右）外側のフォルダーを中央にある共通の親フォルダーにマージします。マージが返される間に発生したマージの不一致の数。

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

Close

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

ユーザーがフォルダー比較ウィンドウを閉じると発生します。

FolderComparisonComplete

IDL	`HRESULT FolderComparisonComplete([in] FolderComparisonResult nResult)`
.NET	`void FolderComparisonComplete(FolderComparisonResult nResult)`
VB6	`FolderComparisonComplete(nResult As FolderComparisonResult)`

フォルダー比較が完了したときに発生します。結果コードを使って、比較の結果を確認できます。

引数

nResult
比較操作の結果。

FolderRetestComplete

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

フォルダー比較の再テスト操作が終了すると発生します。

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