> GetOpenDocumentByName Method (ISldWorks)
Welcome
Getting Started
SolidWorks API Help
FeatureWorks API Help
SolidWorks Document Manager API Help
eDrawings API Help
SolidWorks Routing API Help
SolidWorks Simulation API Help
SolidWorks Utilities API Help
SolidWorks Workgroup PDM API Help
Hide Table of Contents Show Table of Contents
GetOpenDocumentByName Method (ISldWorks)

Gets the open document with the specified name.

.NET Syntax

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

Parameters

DocumentName

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

Return Value

Open model document or NULL if the operation fails

Example

Remarks

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

Availability

SolidWorks 2000 FCS, Revision Number 8.0


Related SolidWorks Forum Content

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:   GetOpenDocumentByName Method (ISldWorks)
*Comment:  
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) 2012 SP05

The search functionality within the web help is in a beta test phase and you may experience periodic delays or interruptions in its performance. These are the normal and ordinary features of a beta test and shall not under any circumstances give rise to any liability on the part of DS SolidWorks or its licensors. The topics within the Web-based help are not beta topics; they document API Help (English only) 2012 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.