Hide Table of Contents
GetAllExternalReferences2 Method (ISwDMDocument5)

Obsolete. Superseded by ISwDMDocument12::GetAllExternalReferences3.

.NET Syntax

Visual Basic (Declaration) 
Function GetAllExternalReferences2( _
   ByVal pSrcOption As SwDMSearchOption, _
   ByRef brokenRefVar As System.Object _
) As System.Object
Visual Basic (Usage) 
Dim instance As ISwDMDocument5
Dim pSrcOption As SwDMSearchOption
Dim brokenRefVar As System.Object
Dim value As System.Object
 
value = instance.GetAllExternalReferences2(pSrcOption, brokenRefVar)
C# 
System.object GetAllExternalReferences2( 
   SwDMSearchOption pSrcOption,
   out System.object brokenRefVar
)
C++/CLI 
System.Object^ GetAllExternalReferences2( 
&   SwDMSearchOption^ pSrcOption,
&   [Out] System.Object^ brokenRefVar
) 

Parameters

pSrcOption
Pointer to the ISwDMSearchOption object
brokenRefVar
Array of the statuses of the any broken external references as defined in swDmReferenceStatus (see Remarks)

Return Value

Array of the names of the external references used in this document

Remarks

Although this method returns valid data for files created in SOLIDWORKS 2005 and earlier, this method only returns valid data for the brokenRefVar argument for files created in SOLIDWORKS 2005 files and later. For files created in versions of SOLIDWORKS earlier than SOLIDWORKS 2005, it returns swDmReferenceStatusUnknown for brokenRefVar.

 

Call this method before calling ISwDMDocument::ReplaceReference.

 

The SOLIDWORKS Document Manager API applies the same rules when searching for a reference as described in the SOLIDWORKS Help topic "Search Routine for Referenced Documents". The mix-and-match of sub-folder combinations is applied to the current document, which for the SOLIDWORKS Document Manager is the document attached using ISwDMApplication::GetDocument and the reference being searched for. You can set up the list of folders to be searched using ISwDMSearchOption::AddSearchPath, which is equivalent to using the SOLIDWORKS user-interface commands Tools, Options, System Options, File Locations, Referenced Documents.

 

Two differences between SOLIDWORKS and the SOLIDWORKS Document Manager API searches are:

  • the path of the last opened visible top-level document (drawing or assembly) is not tried directly.

  • the last user path is not tried directly.

as these concepts have little meaning when SOLIDWORKS is not running.

 

Because the search routine is shared between SOLIDWORKS and the SOLIDWORKS Document Manager API, most of the same changes apply going from SOLIDWORKS 2006 to SOLIDWORKS 2007 and later. However, one significant change related to caching of resolved paths for references being searched for in SOLIDWORKS does not apply to the SOLIDWORKS Document Manager API. In SOLIDWORKS 2007 and later, the next time these references are needed, a simple lookup suffices instead of a potentially lengthy search. However, because this caching mechanism was not applied to the SOLIDWORKS Document Manager API, the SOLIDWORKS Document Manager API in 2006 and 2007, and later, exhibit similar behavior.

 

See Also

Availability

SOLIDWORKS Document Manager API 2005 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:   GetAllExternalReferences2 Method (ISwDMDocument5)
*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) 2018 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.