<xml> </xml>

SOLIDWORKS PDM Professional API Help | Send Feedback
GetFileCopy Method (IEdmVersion5)
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 > IEdmVersion5 Interface : GetFileCopy Method (IEdmVersion5)

Visual Basic
C#
C++/CLI

lParentWnd
  Parent window handle

poPathOrFolderID
  ID or path of the folder where to copy the file; 0 to place a copy of the file in all of its shared folders (default) (see Remarks)

lEdmGetFlags
  Optional combination of EdmGetFlag bits; default is EdmGetFlag.EdmGet_MakeReadOnly

bsNewName
  Optional new name of the copied file; "" to create a copy using the file's current name

Retrieves from the archive a copy of this version of a file and places it in the specified location.

# 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
  ID or path of the folder where to copy the file; 0 to place a copy of the file in all of its shared folders (default) (see Remarks)
lEdmGetFlags
  Optional combination of EdmGetFlag bits; default is EdmGetFlag.EdmGet_MakeReadOnly
bsNewName
  Optional new name of the copied file; "" to create a copy using the file's current name

# Example

Check Out and Copy File (VB.NET)
Check Out and Copy File (C#)

# Remarks

If you specify a folder path in poPathOrFolderID, it 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.

# See Also

####

IEdmVersion5 Interface
IEdmVersion5 Members
IEdmFile5::GetFileCopy Method ()
IEdmRevision5::GetFileCopy Method ()

# Availability

SOLIDWORKS PDM Professional Version 5.2