Hide Table of Contents
SetSearchFolders Method (ISldWorks)

Sets the current folder search path as shown in Tools > Options > System Options > File Locations > Show folders for  > Referenced Documents.

.NET Syntax

Visual Basic (Declaration) 
Function SetSearchFolders( _
   ByVal FolderType As System.Integer, _
   ByVal Folders As System.String _
) As System.Boolean
Visual Basic (Usage) 
Dim instance As ISldWorks
Dim FolderType As System.Integer
Dim Folders As System.String
Dim value As System.Boolean
 
value = instance.SetSearchFolders(FolderType, Folders)
C# 
System.bool SetSearchFolders( 
   System.int FolderType,
   System.string Folders
)
C++/CLI 
System.bool SetSearchFolders( 
&   System.int FolderType,
&   System.String^ Folders
) 

Parameters

FolderType
The search folder type; the only type currently supported is swDocumentType; for an up-to-date listing, see swSearchFolderTypes_e
Folders

String containing all of the search folders; each search folder should be separated by a semicolon

Return Value

True if the search folders were set, false if not

Example

Remarks

The search folders are used by SOLIDWORKS based on their order. Folders at the top of the list get searched first and folders at the bottom of the list get searched last.

This method does not allow you to incrementally add to the search folders list. Calling this method overwrites the existing search folder settings. If you want to add a folder to the existing search folder list, you must get the current search folder list using ISldWorks::GetSearchFolders and then add your folder string at the appropriate location.

Search folder settings are ignored unless Tools > Options > System Options > External References > Search file locations for external references is selected. To get and set Search file locations for external references in the SOLIDWORKS API, use swUserPreferenceToggle_e.swUseFolderSearchRules with ISldWorks::GetUserPreferenceToggle and ISldWorks::SetUserPreferenceToggle, respectively.

 

See Also



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:   SetSearchFolders Method (ISldWorks)
*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.