Hide Table of Contents
GetOpenDocumentByName Method (ISldWorks)

Gets the open document with the specified name.

.NET Syntax

Visual Basic (Declaration) 
Function GetOpenDocumentByName( _
   ByVal DocumentName As System.String _
) As System.Object
Visual Basic (Usage) 
Dim instance As ISldWorks
Dim DocumentName As System.String
Dim value As System.Object
value = instance.GetOpenDocumentByName(DocumentName)
System.object GetOpenDocumentByName( 
   System.string DocumentName
System.Object^ GetOpenDocumentByName( 
&   System.String^ DocumentName



Fully qualified name of the open document (path, filename, and file extension)

Return Value

Open model document or NULL if the operation fails



Only call this method for a document that has already been opened in its own window. If you call this method for a document that has not been opened in its own window, then methods on the returned object may not work as expected.

This method is useful for getting a SOLIDWORKS document object when you only have the document name. For example, SOLIDWORKS event FileOpenNotify2 provides the file name of the document opened, and you can use that name with this method to get the document's object pointer.


See Also


SOLIDWORKS 2000 FCS, Revision Number 8.0

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

Subject:   Feedback on Help Topics
Page:   GetOpenDocumentByName Method (ISldWorks)
*   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:


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

Web Help Content Version: API Help (English only) 2016 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.