Hide Table of Contents
MoveDocument Method (ISwDMApplication)

Moves a single document and optionally updates references to it.

.NET Syntax

Visual Basic (Declaration) 
Function MoveDocument( _
   ByVal fromName As System.String, _
   ByVal toName As System.String, _
   ByVal fromChildren As System.Object, _
   ByVal toChildren As System.Object, _
   ByVal option As System.Integer, _
   ByVal pSrcOption As SwDMSearchOption _
) As System.Integer
Visual Basic (Usage) 
Dim instance As ISwDMApplication
Dim fromName As System.String
Dim toName As System.String
Dim fromChildren As System.Object
Dim toChildren As System.Object
Dim option As System.Integer
Dim pSrcOption As SwDMSearchOption
Dim value As System.Integer
 
value = instance.MoveDocument(fromName, toName, fromChildren, toChildren, option, pSrcOption)
C# 
System.int MoveDocument( 
   System.string fromName,
   System.string toName,
   System.object fromChildren,
   System.object toChildren,
   System.int option,
   SwDMSearchOption pSrcOption
)
C++/CLI 
System.int MoveDocument( 
&   System.String^ fromName,
&   System.String^ toName,
&   System.Object^ fromChildren,
&   System.Object^ toChildren,
&   System.int option,
&   SwDMSearchOption^ pSrcOption
)

Parameters

fromName
Full path and filename of the document to move
toName
Full path and filename of the new document to which to move the document specified for fromName
fromChildren
Array containing the full path and filenames of the child documents dependent on the document specified for fromName
toChildren
Array containing the new full path and filenames for the child documents to which to move the documents specified for fromChildren
option
Move options as defined by SwDmCopyOptions
pSrcOption
Pointer to an ISwDMSearchOption object

Return Value

Success or error code as defined by SwDmMoveCopyError

Remarks

If a document is opened, you must call ISwDMDocument::CloseDoc to close it before calling this method.
 

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:   MoveDocument 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) 2024 SP04

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.30