VSProject.CopyProject Method

Definition

Namespace:

VSLangProj

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

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

public:
 void CopyProject(System::String ^ bstrDestFolder, System::String ^ bstrDestUNCPath, VSLangProj::prjCopyProjectOption copyProjectOption, System::String ^ bstrUsername, System::String ^ bstrPassword);

public:
 void CopyProject(Platform::String ^ bstrDestFolder, Platform::String ^ bstrDestUNCPath, VSLangProj::prjCopyProjectOption copyProjectOption, Platform::String ^ bstrUsername, Platform::String ^ bstrPassword);

void CopyProject(std::wstring const & bstrDestFolder, std::wstring const & bstrDestUNCPath, VSLangProj::prjCopyProjectOption copyProjectOption, std::wstring const & bstrUsername, std::wstring const & bstrPassword);

[System.Runtime.InteropServices.DispId(13)]
public void CopyProject (string bstrDestFolder, string bstrDestUNCPath, VSLangProj.prjCopyProjectOption copyProjectOption, string bstrUsername, string bstrPassword);

[<System.Runtime.InteropServices.DispId(13)>]
abstract member CopyProject : string * string * VSLangProj.prjCopyProjectOption * string * string -> unit

Public Sub CopyProject (bstrDestFolder As String, bstrDestUNCPath As String, copyProjectOption As prjCopyProjectOption, bstrUsername As String, bstrPassword As String)

Parameters

bstrDestFolder

String

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

bstrDestUNCPath

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

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

String

Required. The user's network login ID.

bstrPassword

String

Required. The user's password.

Attributes

DispIdAttribute

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("http://Localhost/Copy_of_Project", "", _  
         prjCopyProjectOption.prjRunFiles, "", "")  
   Catch ex As System.Exception  
      MsgBox("Cannot copy Web project.")  
   End Try  
End Sub  

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.