Hide Table of Contents
GetFileCopy Method (IEdmFile5)

Gets a copy of the file with the specified version from the archive and deposits it in the specified location.

Syntax

Visual Basic (Declaration) 
Sub GetFileCopy( _
   ByVal lParentWnd As System.Integer, _
   Optional ByRef poVersionNoOrRevisionName As System.Object, _
   Optional ByRef poPathOrFolderID As System.Object, _
   Optional ByVal lEdmGetFlags As System.Integer, _
   Optional ByVal bsNewName As System.String _
) 
C# 
void GetFileCopy( 
   System.int lParentWnd,
   ref System.object poVersionNoOrRevisionName,
   ref System.object poPathOrFolderID,
   System.int lEdmGetFlags,
   System.string bsNewName
)
C++/CLI 
void GetFileCopy( 
&   System.int lParentWnd,
&   System.Object^% poVersionNoOrRevisionName,
&   System.Object^% poPathOrFolderID,
&   System.int lEdmGetFlags,
&   System.String^ bsNewName
) 

Parameters

lParentWnd
Parent window handle
poVersionNoOrRevisionName
Version number or revision name of the file to get; 0 or "" to get the latest version
poPathOrFolderID
Optional folder ID or path where to deposit the file; default is to deposit the file in all of its parent folders (see Remarks)
lEdmGetFlags
Optional combination of EdmGetFlag bits; default is EdmGetFlag.EdmGet_MakeReadOnly
bsNewName
Optional new name of the copy of this file; empty string to use the file's current name

Example

Remarks

If poPathOrFolderID = 0, then the file is copied to all folders to which this file is shared. If poPathOrFolderID is a folder path, it must be terminated by a backslash ('\').

To retrieve several files, use IEdmBatchGet, which is more efficient than calling this method several times.

Return codes:

  • S_OK: The method successfully executed.
  • E_EDM_INVALID_REVISION_NUMBER: The revision was not found.  
  • E_EDM_PERMISSION_DENIED: The logged-in user lacks permission to see the specified version of the file.
  • E_EDM_FILE_NOT_FOUND: The file was not found in the vault.
 

See Also

Availability

SOLIDWORKS PDM Professional Version 5.2


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:   GetFileCopy Method (IEdmFile5)
*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) 2016 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.