SOLIDWORKS PDM Professional API Help Send Feedback
GetFileCopy Method (IEdmEnumeratorVersion5)
See Also 
EPDM.Interop.epdm Namespace > IEdmEnumeratorVersion5 Interface : GetFileCopy Method (IEdmEnumeratorVersion5)


lParentWnd
Parent window handle; 0 if none
poVersionNoOrRevisionName
Version number or revision string; 0 or "" to get the latest version
poPathOrFolderID
Optional ID or path of the folder where to deposit the file; default is to deposit in all of its parent folders (see Remarks
lEdmGetFlags
Optional combination of EdmGetFlag bits; default is EdmGet_MakeReadOnly
bsNewName
Optional new name for the retrieved file; "" indicates to use the file's current name
Retrieves a copy of a file with the specified version from the archive and deposits it in the specified folder.

Syntax

Visual Basic 
Sub GetFileCopy( _
   ByVal lParentWnd As System.Integer, _
   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; 0 if none
poVersionNoOrRevisionName
Version number or revision string; 0 or "" to get the latest version
poPathOrFolderID
Optional ID or path of the folder where to deposit the file; default is to deposit in all of its parent folders (see Remarks
lEdmGetFlags
Optional combination of EdmGetFlag bits; default is EdmGet_MakeReadOnly
bsNewName
Optional new name for the retrieved file; "" indicates to use the file's current name

Example

See the example for IEdmFile5::GetFileCopy.

Remarks

If you specify a folder ID of 0 in poPathOrFolderID, SOLIDWORKS PDM Professional deposits the file in all of the folders it is shared to. If you specify a path in poPathOrFolderID, it can either be a file path or a folder path. Folder paths must be terminated by a backslash ('\').

Return codes:

  • S_OK: The method successfully executed.
  • E_EDM_FILE_NOT_FOUND: The file is not found in the vault.
  • E_EDM_PERMISSION_DENIED: The user is not permitted to see the specified version of the file. 
  • E_EDM_INVALID_REVISION_NUMBER: The revision is not found.
 

See Also

Availability

SOLIDWORKS PDM Professional Version 5.2