VSProject.CopyProject Method

Copies some or all of a Web project to a new location.

Namespace:  VSLangProj
Assembly:  VSLangProj (in VSLangProj.dll)

Syntax

'Declaration
Sub CopyProject ( _
    bstrDestFolder As String, _
    bstrDestUNCPath As String, _
    copyProjectOption As prjCopyProjectOption, _
    bstrUsername As String, _
    bstrPassword As String _
)

void CopyProject(
    string bstrDestFolder,
    string bstrDestUNCPath,
    prjCopyProjectOption copyProjectOption,
    string bstrUsername,
    string bstrPassword
)

void CopyProject(
    [InAttribute] String^ bstrDestFolder, 
    [InAttribute] String^ bstrDestUNCPath, 
    [InAttribute] prjCopyProjectOption copyProjectOption, 
    [InAttribute] String^ bstrUsername, 
    [InAttribute] String^ bstrPassword
)

abstract CopyProject : 
        bstrDestFolder:string * 
        bstrDestUNCPath:string * 
        copyProjectOption:prjCopyProjectOption * 
        bstrUsername:string * 
        bstrPassword:string -> unit

function CopyProject(
    bstrDestFolder : String, 
    bstrDestUNCPath : String, 
    copyProjectOption : prjCopyProjectOption, 
    bstrUsername : String, 
    bstrPassword : String
)

Parameters

• bstrDestFolder
  Type: String

  Required. The destination folder for the new project. The folder is created if it does not exist. This string takes the form "https://ServerName/CopyName/".

• bstrDestUNCPath
  Type: String

  Required. The UNC path for file-sharing if the project to be copied is using file-share access. Use the empty string if the project is using FrontPage Server Extensions access.

• copyProjectOption
  Type: VSLangProj.prjCopyProjectOption

  Required. A prjCopyProjectOption value that determines which project files are copied — all the files, all the project files, or only the files needed to run the application.

• bstrUsername
  Type: String

  Required. The user's network login ID.

• bstrPassword
  Type: String

  Required. The user's password. 

Remarks

This method, used to copy Web projects, provides more functionality than a simple xcopy of the project files, but less functionality than deployment. The CopyProject method will make the appropriate changes to IIS and the project folder on the Web server, so that development can continue as usual on the project. Deployment provides more features for setting up a Web, including creating databases and message queues.

This method copies only Web projects. Web projects are projects created from the ASP.NET Web application, XML Web Service, and Empty Web Project templates in the New Project dialog box. If the project is a local project, an exception is raised.

If the destination folders or files already exist, they will be overwritten.

Examples

[Visual Basic]

' Macro editor
' Copies the first project in the solution.
' This procedure could fail if the first project is not a Visual Basic
' or Visual C# project, or if the project is not a Web application.
Imports VSLangProj
Public Sub CopyWeb()
   Try
      Dim proj As VSLangProj.VSProject = _
         CType(DTE.Solution.Projects.Item(1).Object, VSLangProj.VSProject)
      proj.CopyProject("https://Localhost/Copy_of_Project", "", _
         prjCopyProjectOption.prjRunFiles, "", "")
   Catch ex As System.Exception
      MsgBox("Cannot copy Web project.")
   End Try
End Sub

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

VSProject Interface

VSLangProj Namespace