FolderComparison オブジェクト

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

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

Information このオブジェクトによって表される比較が閉じると、Close イベントのハンドラーによって、メソッドやプロパティにアクセスする最後の機会が提供されます。その後はアクセスしようとすると、エラーになります。

プロパティ

Active読み取り/書き込みICommonUI

比較ウィンドウのアクティブ状態。

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

Busy読み取り/書き込みIFolderComparison

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

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

FileName読み取り専用IFolderComparison

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

IDL [propget] HRESULT FileName(
    [in] long nIndex,
    [in] short nFolder,
    [out, retval] BSTR* pValue)
.NET String get_FileName(
    Int32 nIndex,
    Int16 nFolder)
  • nIndex
    比較結果へのインデックス（0 ベース）。NumberOfEntries も参照してください。
  • nFolder
    結果行を含んでいるフォルダー（0、1、または 2）。

FilePath読み取り専用IFolderComparison

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

IDL [propget] HRESULT FilePath(
    [in] long nIndex,
    [in] short nFolder,
    [out, retval] BSTR* pValue)
.NET String get_FilePath(
    Int32 nIndex,
    Int16 nFolder)
  • nIndex
    比較結果へのインデックス（0 ベース）。NumberOfEntries も参照してください。
  • nFolder
    結果行を含んでいるフォルダー（0、1、または 2）。

FileType読み取り専用IFolderComparison

比較結果内の指定されたインデックスおよび列にあるファイルの種類。

IDL [propget] HRESULT FileType(
    [in] long nIndex,
    [out, retval] FolderFileType* pValue)
.NET FolderFileType get_FileType(
    Int32 nIndex)
  • nIndex
    比較結果へのインデックス（0 ベース）。NumberOfEntries も参照してください。

Folder読み取り/書き込みIFolderComparison

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

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)
  • nFolder
    結果行を含んでいるフォルダー（0、1、または 2）。

FullFilePath読み取り専用IFolderComparison

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

IDL [propget] HRESULT FullFilePath(
    [in] long nIndex,
    [in] short nFolder,
    [out, retval] BSTR* pValue)
.NET String get_FullFilePath(
    Int32 nIndex,
    Int16 nFolder)
  • nIndex
    比較結果へのインデックス（0 ベース）。NumberOfEntries も参照してください。
  • nFolder
    結果行を含んでいるフォルダー（0、1、または 2）。

Height読み取り/書き込みICommonUI

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

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

Left読み取り/書き込みICommonUI

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

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

Maximized読み取り/書き込みICommonUI

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

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

Minimized読み取り/書き込みICommonUI

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

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

NumberOfEntries読み取り専用IFolderComparison

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

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

NumberOfSelectedItems読み取り専用IFolderComparison

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

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

Selected読み取り/書き込みIFolderComparison

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

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)
  • nIndex
    比較結果へのインデックス（0 ベース）。NumberOfEntries も参照してください。

Top読み取り/書き込みICommonUI

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

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

ViewType読み取り/書き込みIComparison

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

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

Visible読み取り/書き込みICommonUI

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

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

Width読み取り/書き込みICommonUI

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

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

メソッド

CloseICommonUI

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

IDL HRESULT Close()
.NET void Close()

CompareIComparison

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

IDL HRESULT Compare(
    [in] VARIANT strFirst,
    [in] VARIANT strSecond,
    [in, optional] VARIANT strThird)
.NET void Compare(
    Object strFirst,
    Object strSecond,
    Object strThird)
  • strFirst
    第 1 フォルダーへの完全修飾パス。
  • strSecond
    第 2 フォルダーへの完全修飾パス。
  • strThird オプション
    第 3 フォルダーへの完全修飾パス。

CompareSelectedIFolderComparison

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

IDL HRESULT CompareSelected()
.NET void CompareSelected()

DeselectAllIFolderComparison

比較リスト内のファイルのすべての選択を解除します。

IDL HRESULT DeselectAll()
.NET void DeselectAll()

GiveUserControlICommonUI

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

IDL HRESULT GiveUserControl()
.NET void GiveUserControl()

HideEmptyFoldersIFolderComparison

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

IDL HRESULT HideEmptyFolders()
.NET void HideEmptyFolders()

PrintIComparison

フォルダー比較を印刷します。

IDL HRESULT Print(
    [in] VARIANT_BOOL bShowPrinterDialog,
    [in] PageOrientation nOrientation)
.NET void Print(
    Boolean bShowPrinterDialog,
    PageOrientation nOrientation)
  • bShowPrinterDialog
    デフォルトは FALSE です。印刷を行う前に印刷ダイアログをユーザーに表示するかどうかを示します。
  • nOrientation
    デフォルトは poLandscape です。縦置き、横置きのどちらの向きで印刷するかを示します。

RefreshIComparison

ウィンドウに表示されているフォルダーを再度比較します。

IDL HRESULT Refresh()
.NET void Refresh()

ReportIComparison

フォルダー比較のレポートを生成します。

IDL HRESULT Report(
    [in] BSTR bstrReporter,
    [in] LineEndingStyle nLineEndingStyle,
    [in] BSTR strOutputFile)
.NET void Report(
    String bstrReporter,
    LineEndingStyle nLineEndingStyle,
    String strOutputFile)
  • bstrReporter
    レポートの生成に使用するレポーターのショート ネーム。有効なショート ネームは xml と html です。すべてのレポーターで 3 者間比較レポートの生成がサポートされているわけではないことに留意してください。
  • nLineEndingStyle
    生成するレポート ファイルで使用する行終端のタイプ。
  • strOutputFile
    レポート用の出力ファイルの名前。レポーターが 2 つ以上のファイルを生成する場合、それらのファイルにはこの名前を基にした名前が付けられます。

Report2IComparison

フォルダー比較のレポートを生成します。

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)
  • 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 つ以上のファイルを生成する場合、それらのファイルにはこの名前を基にした名前が付けられます。

RestoreICommonUI

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

IDL HRESULT Restore()
.NET void Restore()

RestoreIFolderComparison

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

IDL HRESULT Restore()
.NET void Restore()

RetestSelectedIFolderComparison

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

IDL HRESULT RetestSelected()
.NET void RetestSelected()

SaveComparisonIComparison

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

IDL HRESULT SaveComparison(
    [in] BSTR filename)
.NET void SaveComparison(
    String filename)
  • filename
    比較を保存するファイルの名前。

SelectAllIFolderComparison

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

IDL HRESULT SelectAll()
.NET void SelectAll()

SelectChangedIFolderComparison

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

IDL HRESULT SelectChanged()
.NET void SelectChanged()

SetPanelTitlesIComparison

フォルダー列の上に表示するタイトルを設定します。

IDL HRESULT SetPanelTitles(
    [in] VARIANT strFirst,
    [in] VARIANT strSecond,
    [in, optional] VARIANT strThird)
.NET void SetPanelTitles(
    Object strFirst,
    Object strSecond,
    Object strThird)
  • strFirst
    第 1 フォルダー列のタイトル。
  • strSecond
    第 2 フォルダー列のタイトル。
  • strThird オプション
    第 3 フォルダー列のタイトル。

StopIFolderComparison

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

IDL HRESULT Stop()
.NET void Stop()

ThreeWayMergeIFolderComparison

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

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

イベント

CloseIFolderComparisonEvents

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

IDL HRESULT Close()
.NET void Close()

FolderComparisonCompleteIFolderComparisonEvents

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

IDL HRESULT FolderComparisonComplete(
    [in] FolderComparisonResult nResult)
.NET void FolderComparisonComplete(
    FolderComparisonResult nResult)
  • nResult
    比較操作の結果。

FolderRetestCompleteIFolderComparisonEvents

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

IDL HRESULT FolderRetestComplete()
.NET void FolderRetestComplete()