<xml> </xml>

SOLIDWORKS PDM Professional API Help | Send Feedback
AddFileFromVault Method (IEdmBatchAdd)
See Also

Collapse All Expand All Language Filter: All Language Filter: Multiple Language Filter: Visual Basic Language Filter: C# Language Filter: C++/CLI

EPDM.Interop.epdm Namespace > IEdmBatchAdd Interface : AddFileFromVault Method (IEdmBatchAdd)

Visual Basic
C#
C++/CLI

lSourceFileID
  ID of file to copy

lSourceFolderID
  ID of folder of file to copy

lDestinationFolderID
  ID of folder to which to copy the file

lArg
  Caller-defined argument.

bsNewName
  Optional new name of file.

lEdmAddFlags
  Combination of EdmAddFlag bits

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

# Syntax

Visual Basic |
--- | ---

    Sub AddFileFromVault( _
       ByVal lSourceFileID As System.Integer, _
       ByVal lSourceFolderID As System.Integer, _
       ByVal lDestinationFolderID As System.Integer, _
       Optional ByVal lArg As System.Integer, _
       Optional ByVal bsNewName As System.String, _
       Optional ByVal lEdmAddFlags As System.Integer _
    )

C# |
--- | ---

    void AddFileFromVault(
       System.int lSourceFileID,
       System.int lSourceFolderID,
       System.int lDestinationFolderID,
       System.int lArg,
       System.string bsNewName,
       System.int lEdmAddFlags
    )

C++/CLI |
--- | ---

    void AddFileFromVault(
    &   System.int lSourceFileID,
    &   System.int lSourceFolderID,
    &   System.int lDestinationFolderID,
    &   System.int lArg,
    &   System.String^ bsNewName,
    &   System.int lEdmAddFlags
    )

#### Parameters

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

# Remarks

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

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

####

IEdmBatchAdd Interface
IEdmBatchAdd Members

# Availability

Version 6.4 of SOLIDWORKS PDM Professional