FolderComparison Object

This object represents a Merge folder comparison window. The window isn’t necessarily visible on screen and can be used either to perform folder comparison services for a client or to present folder comparisons on the screen to the user.

Use the methods and properties exposed by this object to perform folder comparisons, extract results, and alter the appearance of the folder comparison window.

Properties

Activeread/writeICommonUI

The active state of the comparison window.

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

Busyread/writeIFolderComparison

Whether the comparison window is busy performing a folder comparison or retest operation.

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

FileNameread-onlyIFolderComparison

The name of the file at the specified index and column in the comparison results.

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
    The index (0 based) into the comparison results. See also NumberOfEntries.
  • nFolder
    The folder (0, 1, or 2) containing the result row.

FilePathread-onlyIFolderComparison

The path and name of the file at the specified index and column in the comparison results.

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
    The index (0 based) into the comparison results. See also NumberOfEntries.
  • nFolder
    The folder (0, 1, or 2) containing the result row.

FileTyperead-onlyIFolderComparison

The type of the file at the specified index in the comparison results.

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
    The index (0 based) into the comparison results. See also NumberOfEntries.

Folderread/writeIFolderComparison

The fully qualified path to the specified folder to be compared.

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
    The folder (0, 1, or 2) containing the result row.

FullFilePathread-onlyIFolderComparison

The fully qualified path and name of the file at the specified index and column in the comparison results.

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
    The index (0 based) into the comparison results. See also NumberOfEntries.
  • nFolder
    The folder (0, 1, or 2) containing the result row.

Heightread/writeICommonUI

The height of the comparison window in pixels.

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

Leftread/writeICommonUI

The location of the left edge pixel coordinate of the comparison window.

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

Maximizedread/writeICommonUI

The maximized state of the comparison window.

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

Minimizedread/writeICommonUI

The minimized state of the comparison window.

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

NumberOfEntriesread-onlyIFolderComparison

The number of items in the comparison results. The comparison results contain the items in the same order as displayed to the user in the folder comparison window.

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

NumberOfSelectedItemsread-onlyIFolderComparison

The number of selected items in the comparison results.

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

Selectedread/writeIFolderComparison

Indicates whether the file at the specified index in the comparison results is 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
    The index (0 based) into the comparison results. See also NumberOfEntries.

Topread/writeICommonUI

The location of the top edge pixel coordinate of the comparison window.

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

ViewTyperead/writeIComparison

The comparison type (two way or three way layout).

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

Visibleread/writeICommonUI

The visible state of the comparison window.

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

Widthread/writeICommonUI

The width of the comparison window in pixels.

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

Methods

CloseICommonUI

Closes the comparison window.

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

CompareIComparison

Compares two or three folders. This method is synchronous. An event ComparisonComplete is fired when the comparison is finished to report errors and results.

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])
  • strFirst
    The fully qualified path to the first folder.
  • strSecond
    The fully qualified path to the second folder.
  • strThird optional
    The fully qualified path to the third folder.

CompareSelectedIFolderComparison

Opens file comparison windows for the selected files in the comparison list.

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

DeselectAllIFolderComparison

Deselects all the files in the comparison list.

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

GiveUserControlICommonUI

Gives control over the lifetime of the comparison window to the user. Merge will not automatically close the window when outstanding automation references are released.

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

HideEmptyFoldersIFolderComparison

Hides folders that contain no changed, inserted, or removed files.

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

PrintIComparison

Prints the folder comparison.

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
    Defaults to FALSE. Whether to show the printer dialog to the user before printing.
  • nOrientation
    Defaults to poLandscape. Whether to print in portrait or landscape mode.

RefreshIComparison

Recompares the folders displayed in the window.

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

ReportIComparison

Generates a report for the folder comparison.

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
    The short-name of the reporter that should be used to generate the report. Valid names are xml and html. Please note that not all reporters support the generation of three-way comparison reports.
  • nLineEndingStyle
    The type of line-ending to use in the generated report file(s).
  • strOutputFile
    The name of the output file for the report. If the reporter generates more than one file, those files will have names based on this one.

Report2IComparison

Generates a report for the folder comparison.

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
    The short-name of the reporter that should be used to generate the report. Valid names are xml and html. Please note that not all reporters support the generation of three-way comparison reports.
  • nLineEndingStyle
    The type of line-ending to use in the generated report file(s).
  • vtEncoding
    The character encoding to use for the generated report. It can either be a codepage number, or one of the following strings: UCS2 (Unicode UCS2), UCS2-BE (Unicode UCS2 big endian), UTF8 (Unicode UTF8 with byte-order marker), UTF8-NOBOM (Unicode UTF8 without byte-order marker), UTF7 (Unicode UTF7).
  • strOutputFile
    The name of the output file for the report. If the reporter generates more than one file, those files will have names based on this one.

RestoreICommonUI

Restores the comparison window from minimized or maximised state to its normal resizable state.

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

RestoreIFolderComparison

Restores the folder comparison window (undoes the effect of a minimize or maximize).

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

RetestSelectedIFolderComparison

Retests the selected files in the comparison list.

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

SaveComparisonIComparison

Saves the comparison to a file. We recommend that you use the .cmp7 extension in the filename.

IDL HRESULT SaveComparison(
    [in] BSTR filename)
.NET void SaveComparison(
    String filename)
VB6 SaveComparison(
    filename As String)
  • filename
    The name of the file to which the comparison should be saved.

SelectAllIFolderComparison

Selects all the files in the comparison results.

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

SelectChangedIFolderComparison

Selects all the changed files in the comparison results.

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

SetPanelTitlesIComparison

Sets the titles shown above the folder columns.

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
    The title for the first folder column.
  • strSecond
    The title for the second folder column.
  • strThird optional
    The title for the third folder column.

StopIFolderComparison

Stops any ongoing comparisons, retests or refreshes.

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

ThreeWayMergeIFolderComparison

Merges the two outer folders in a three-way comparison into the central common ancestor folder. The number of merging conflicts encountered during the merge is returned.

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

Events

CloseIFolderComparisonEvents

Occurs when the folder comparison window is closed by the user.

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

FolderComparisonCompleteIFolderComparisonEvents

Occurs when the folder comparison finishes. The result code can be used to determine the success of the comparison.

IDL HRESULT FolderComparisonComplete(
    [in] FolderComparisonResult nResult)
.NET void FolderComparisonComplete(
    FolderComparisonResult nResult)
VB6 FolderComparisonComplete(
    nResult As FolderComparisonResult)
  • nResult
    The result of the comparison operation.

FolderRetestCompleteIFolderComparisonEvents

Occurs when a folder comparison retest operation finishes.

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