Function GetExternalFeatureReferences( _
   ByRef ExtRefOption As SwDMExternalReferenceOption _
) As System.Integer

Dim instance As ISwDMDocument15
Dim ExtRefOption As SwDMExternalReferenceOption
Dim value As System.Integer
 
value = instance.GetExternalFeatureReferences(ExtRefOption)

System.int GetExternalFeatureReferences( 
   out SwDMExternalReferenceOption ExtRefOption
)

System.int GetExternalFeatureReferences( 
&   [Out] SwDMExternalReferenceOption^ ExtRefOption
) 

Parameters

ExtRefOption

An ISwDMExternalReferenceOption object (see Remarks)

Return Value

Use this method with parts and assemblies; use ISwDMDocument13::GetAllExternalReferences4 with drawings.

This method only works in documents saved in SOLIDWORKS 2011 SP0 or later.

Before calling this method:

1. Call ISwDMApplication3::GetExternalReferenceOptionObject to obtain an ISwDMExternalReferenceOption object.
2. Set ISwDMExternalReferenceOption::Configuration.
3. Set ISwDMExternalReferenceOption::NeedSuppress.
4. Set ISwDMExternalReferenceOption::SearchOption.
5. Assign this method's ExtRefOption parameter to the ISwDMExternalReferenceOption object.

After calling this method, call ISwDMExternalReferenceOption::ExternalReferences and ISwDMExternalReferenceOption::ReferencedConfigurations to obtain the external feature references and their configurations.

To find out if an external feature reference is suppressed:

1. Call ISwDMComponent6::PathName to set one of the external components returned by ISwDMDocument15::GetExternalFeatureReferences.
2. Call ISwDMComponent::IsSuppressed.

The suppression states and other information of all of the external references are also embedded in the parent document. To obtain this information in XML format, call ISwDMDocument::GetXMLStream.

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. The mix-and-match of sub-folder combinations is applied to the current document, which for the SOLIDWORKS Document Manager API 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.

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.