<xml> </xml>

SOLIDWORKS PDM Professional API Help | Send Feedback
GetFileCopy Method (IEdmFile5)
See Also Example

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 > IEdmFile5 Interface : GetFileCopy Method (IEdmFile5)

Visual Basic
C#
C++/CLI

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

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

# Syntax

Visual Basic |
--- | ---

    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

Add Files to Vault (VB.NET)
Add Files to Vault (C#)

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

See Return Codes for the complete list of potential success and error codes. The following are just a few examples:

- 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

####

IEdmFile5 Interface
IEdmFile5 Members
IEdmFile5::LockFile Method ()

# Availability

SOLIDWORKS PDM Professional Version 5.2