Hide Table of Contents
CompareDocument2 Method (ICompareDocument)

Compares the properties of the specified SolidWorks documents and generates a report.

.NET Syntax

Visual Basic (Declaration) 
Function CompareDocument2( _
   ByVal reffile As String, _
   ByVal refconfig As String, _
   ByVal modfile As String, _
   ByVal modconfig As String, _
   ByVal lOperationOptions As Integer, _
   ByVal lResultOptions As Integer, _
   ByVal reportname As String, _
   ByVal vtAddToBinderOption As Boolean, _
   ByVal vtOverwrite As Boolean _
) As Integer
Visual Basic (Usage) 
Dim instance As ICompareDocument
Dim reffile As String
Dim refconfig As String
Dim modfile As String
Dim modconfig As String
Dim lOperationOptions As Integer
Dim lResultOptions As Integer
Dim reportname As String
Dim vtAddToBinderOption As Boolean
Dim vtOverwrite As Boolean
Dim value As Integer
 
value = instance.CompareDocument2(reffile, refconfig, modfile, modconfig, lOperationOptions, lResultOptions, reportname, vtAddToBinderOption, vtOverwrite)
C# 
int CompareDocument2( 
   string reffile,
   string refconfig,
   string modfile,
   string modconfig,
   int lOperationOptions,
   int lResultOptions,
   string reportname,
   bool vtAddToBinderOption,
   bool vtOverwrite
)
C++/CLI 
int CompareDocument2( 
&   String^ reffile,
&   String^ refconfig,
&   String^ modfile,
&   String^ modconfig,
&   int lOperationOptions,
&   int lResultOptions,
&   String^ reportname,
&   bool vtAddToBinderOption,
&   bool vtOverwrite
) 

Parameters

reffile
Path and filename of the SolidWorks document containing the referenced part
refconfig
Name of reference part's configuration; if blank, then the active configuration is used
modfile
Path and filename of the SolidWorks document containing the modified part
modconfig

Name of modified part's configuration

lOperationOptions

Compare face, volume, or feature as defined by gtCodOperationOption_e

lResultOptions
Display the results or save the results to a report as defined by gtResultOptions_e
reportname
Path where to write the results report
vtAddToBinderOption
True to add the results report to the Design Binder, false to not
vtOverwrite
True to overwrite an existing results report of the same name, false to not

Return Value

Error as defined by gtError_e

Example

 

See Also

Availability

SolidWorks Utilities API 2006 FCS


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   CompareDocument2 Method (ICompareDocument)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2011 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.