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


lParentWnd
Parent window handle
poPathOrFolderID
Path or ID of the folder where to place the file; default copies the file to all of the folders to which it is shared (see Remarks)
lEdmGetFlags
Optional combination of EdmGetFlag bits; default is EdmGetFlag.EdmGet_MakeReadOnly
bsNewName
Optional new name of the file copy; "" to use the file's current name
Gets a copy of this revision of the file from the archive and places it in the specified folder on the client machine.

Syntax

Visual Basic 
Sub GetFileCopy( _
   ByVal lParentWnd As System.Integer, _
   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 poPathOrFolderID,
   System.int lEdmGetFlags,
   System.string bsNewName
)
C++/CLI 
void GetFileCopy( 
&   System.int lParentWnd,
&   System.Object^% poPathOrFolderID,
&   System.int lEdmGetFlags,
&   System.String^ bsNewName
) 

Parameters

lParentWnd
Parent window handle
poPathOrFolderID
Path or ID of the folder where to place the file; default copies the file to all of the folders to which it is shared (see Remarks)
lEdmGetFlags
Optional combination of EdmGetFlag bits; default is EdmGetFlag.EdmGet_MakeReadOnly
bsNewName
Optional new name of the file copy; "" to use the file's current name

Remarks

If you specify a path for poPathOrFolderID, you can either give 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 was 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 was not found.
 

See Also

Availability

SOLIDWORKS PDM Professional Version 5.2