Hide Table of Contents
GetDocument Method (ISwDMApplication)

Gets the specified document.

.NET Syntax

Visual Basic (Declaration) 
Function GetDocument( _
   ByVal FullPathName As System.String, _
   ByVal docType As SwDmDocumentType, _
   ByVal allowReadOnly As System.Boolean, _
   ByRef result As SwDmDocumentOpenError _
) As SwDMDocument
Visual Basic (Usage) 
Dim instance As ISwDMApplication
Dim FullPathName As System.String
Dim docType As SwDmDocumentType
Dim allowReadOnly As System.Boolean
Dim result As SwDmDocumentOpenError
Dim value As SwDMDocument
 
value = instance.GetDocument(FullPathName, docType, allowReadOnly, result)
C# 
SwDMDocument GetDocument( 
   System.string FullPathName,
   SwDmDocumentType docType,
   System.bool allowReadOnly,
   out SwDmDocumentOpenError result
)
C++/CLI 
SwDMDocument^ GetDocument( 
&   System.String^ FullPathName,
&   SwDmDocumentType docType,
&   System.bool allowReadOnly,
&   [Out] SwDmDocumentOpenError result
)

Parameters

FullPathName
Full path and filename of the document to get
docType

Type of document as defined by SwDmDocumentType

allowReadOnly

True to open the document as read-only, false as read-write

result
Error as defined by SwDmDocumentOpenError

Return Value

Pointer to an ISwDMDocument object

Example

Remarks

If the document is currently open as read-write, then this method fails and returns NULL.

Use ISwDMApplication2::GetDocument2 to get a document using an IStream or IStorage storage.

 

See Also

Availability

SOLIDWORKS Document Manager API 2004 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:   GetDocument Method (ISwDMApplication)
*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) 2022 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.

0.20.23