Hide Table of Contents
AddFileFromVaultToPath Method (IEdmBatchAdd)

Adds a file with the specified ID and folder ID to the batch of files to be added to the vault; the file will be copied to a new vault folder with the specified path.

Syntax

Visual Basic (Declaration) 
Sub AddFileFromVaultToPath( _
   ByVal lSourceFileID As System.Integer, _
   ByVal lSourceFolderID As System.Integer, _
   ByVal bsDestinationFolderPath As System.String, _
   Optional ByVal lArg As System.Integer, _
   Optional ByVal bsNewName As System.String, _
   Optional ByVal lEdmAddFlags As System.Integer _
)
C# 
void AddFileFromVaultToPath( 
   System.int lSourceFileID,
   System.int lSourceFolderID,
   System.string bsDestinationFolderPath,
   System.int lArg,
   System.string bsNewName,
   System.int lEdmAddFlags
)
C++/CLI 
void AddFileFromVaultToPath( 
&   System.int lSourceFileID,
&   System.int lSourceFolderID,
&   System.String^ bsDestinationFolderPath,
&   System.int lArg,
&   System.String^ bsNewName,
&   System.int lEdmAddFlags
)

Parameters

lSourceFileID
ID of file to copy
lSourceFolderID
ID of folder of file to copy
bsDestinationFolderPath
Path of folder to which to copy the file
lArg
Caller-defined argument
bsNewName
Optional new name of file
lEdmAddFlags
Combination of EdmAddFlag bits

Example

See the IEdmBatchAdd examples.

Remarks

Before calling this method, use IEdmBatchAdd::SetFileNameSerNo to specify how to create the name for the new file's data card.

If the specified bsDestinationFolderPath does not exist in the vault, it will be created when the file is added.

After calling this method, you must call IEdmBatchAdd::CommitAdd to actually add the file to the vault.

Return codes:

  • S_OK: The method successfully executed.
  • S_FALSE: One of the arguments is invalid.
 

See Also

Availability

Version 6.4 of SOLIDWORKS PDM Professional


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:   AddFileFromVaultToPath Method (IEdmBatchAdd)
*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) 2023 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.21