VSProject2.CopyProject Method

Definition

Namespace:

VSLangProj80

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 files, all project files, or only files needed to run the application.

bstrUsername

String

Required. The user's network login ID.

bstrPassword

String

Required. The user's password.

Implements

CopyProject(String, String, prjCopyProjectOption, String, String)

Attributes

DispIdAttribute

Examples

This example copies the first project in the solution, as long as it is a Visual Basic or Visual C# project. To run this example as an add-in, see How to: Compile and Run the Automation Object Model Code Examples.

[Visual Basic]

' Add-in code.  
' 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  
Imports VSLangProj80  
Public Sub OnConnection(ByVal application As Object,_  
 ByVal connectMode As ext_ConnectMode, ByVal addInInst As Object, _  
 ByRef custom As Array) Implements IDTExtensibility2.OnConnection  
    applicationObject = CType(application, DTE2)  
    addInInstance = CType(addInInst, AddIn)  
    CopyWeb(applicationObject)  
End Sub  

Public Sub CopyWeb(ByVal dte As DTE2)  
    Try  
        Dim proj As VSProject2 = _  
        CType(applicationObject.Solution.Projects.Item(1).Object, _  
    VSProject2)  
        proj.CopyProject("http://Localhost/Copy_of_Project", "", _  
        prjCopyProjectOption.prjRunFiles, "", "")  
    Catch ex As System.Exception  
        MsgBox("Cannot copy Web project.")  
    End Try  
End Sub  

[C#]

using System.Windows.Forms;  
using VSLangProj;  
using VSLangProj2;  
using VSLangProj80;  
public void OnConnection(object application, ext_ConnectMode  
 connectMode, object addInInst, ref Array custom)  
{  
    applicationObject = (DTE2)application;  
    addInInstance = (AddIn)addInInst;  
    CopyWeb((DTE2)applicationObject);  
}  

public void CopyWeb( DTE2 dte ) {   
    try {   
        VSProject2 proj = ( ( VSProject2 )  
(applicationObject.Solution.Projects.Item( 1 ).Object ) );   
        proj.CopyProject( "http://Localhost/Copy_of_Project", "",  
 prjCopyProjectOption.prjRunFiles, "", "" );   
    }  
    catch ( System.Exception ex ) {  
        MessageBox.Show(ex.ToString());  
        MessageBox.Show( "Cannot copy Web project.");   
    }  
}  

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 makes 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 are overwritten.