272 lines
36 KiB
HTML
272 lines
36 KiB
HTML
<html>
|
|
|
|
<head>
|
|
<title>Copy File Example (C#)</title>
|
|
<meta http-equiv="Content-Language" content="en-us">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
|
|
<link rel="stylesheet" type="text/css" href="ApiHelp.css">
|
|
</head>
|
|
<meta name=MS-HKWD content="C# examples,files">
|
|
|
|
<body>
|
|
<h1><span style="font-weight: normal; font-size: 7.5pt;">SOLIDWORKS PDM Professional API Help</span></h1>
|
|
<h1>Copy File Example (C#)</h1>
|
|
<p>This example shows how to copy a file in the vault to a different
|
|
folder in the vault.</p>
|
|
<p><b>NOTE</b>: If using the primary interop assembly
|
|
provided with SOLIDWORKS PDM Professional, see
|
|
<a href="Using_NET_Framework_in_Applications.htm">Using .NET Framework 4.0 in
|
|
Stand-alone Applications</a>.</p>
|
|
|
|
<p class=APICODE><img border="0" src="CopyFile.gif" width="229" height="170"></p>
|
|
|
|
<pre style="font-family: Courier New; font-size: 13; color: black; background: white"><span style="color:green;">//----------------------------------------------------------------------------</span>
|
|
<span style="color:green;">// Preconditions:</span>
|
|
<span style="color:green;">// 1. Start Microsoft Visual Studio.</span>
|
|
<span style="color:green;">// a. Click F<b>ile > New > Project > Visual C# > Windows Forms Application</b>.</span>
|
|
<span style="color:green;">// b. Type <b>VaultUtilities</b> in <b>Name</b>.</span>
|
|
<span style="color:green;">// c. Click <b>Browse</b> and navigate to the folder where to create </span>
|
|
<span style="color:green;">// the project.</span>
|
|
<span style="color:green;">// d. Click <b>OK</b>. </span>
|
|
<span style="color:green;">// e. Click <b>Show All Files</b> in the Solution Explorer toolbar and expand </span>
|
|
<span style="color:green;">// <b>Form1.cs</b> in the Solution Explorer.</span>
|
|
<span style="color:green;">// f. Replace the code in <b>Form1.cs</b> with <a href="#Form1">this code</a>.</span>
|
|
<span style="color:green;">// g. To create the form, replace the code in <b>Form1.Designer.cs</b> with <a href="#Form1Designer">this code</a>.</span>
|
|
<span style="color:green;">// 2. Add <b>EPDM.Interop.epdm.dll</b> as a reference (right-click the project</span>
|
|
<span style="color:green;">// name in the Solution Explorer, click <b>Add Reference</b>, click </span>
|
|
<span style="color:green;">// <b>Assemblies > Framework</b> in the left-side panel, browse to the top folder of </span>
|
|
<span style="color:green;">// your SOLIDWORKS PDM Professional installation, locate and click </span>
|
|
<span style="color:green;">// <b>EPDM.Interop.epdm.dll</b>, click <b>Open</b>, and click <b>Add</b>).</span>
|
|
<span style="color:green;">// 3. Add <b>EPDM.Interop.EPDMResultCode.dll</b> as a reference (click <b>Browse</b>, locate and </span>
|
|
<span style="color:green;">// click <b>EPDM.Interop.EPDMResultCode.dll</b>, click <b>Open</b>, click <b>Add</b>, and click <b>Close</b>).</span>
|
|
<span style="color:green;">// 4. Right-click <b>EPDM.Interop.epdm</b> in References, click <b>Properties</b>, and set </span>
|
|
<span style="color:green;">// <b>Embed Interop Types</b> to <b>False</b> to handle methods that pass arrays of </span>
|
|
<span style="color:green;">// structures.
|
|
</span><span style="COLOR: green">// 5. Run the Administration tool, log in as admin, expand the vault, </span>
|
|
<span style="COLOR: green">// right-click <b>File Types</b>, click <b>Duplicate file name settings</b>, and </span>
|
|
<span style="COLOR: green">// click <b>Do not allow duplicate files names in this file vault</b>.</span>
|
|
<span style="color:green;">// 6. Ensure that multiple folders exists in vault. </span>
|
|
<span style="color:green;">// 7. Click <b>Debug > Start Debugging</b> or press F5.</span>
|
|
<span style="color:green;">//</span>
|
|
<span style="color:green;">// Postconditions: </span>
|
|
<span style="color:green;">// 1. Displays the Copy file dialog box.</span>
|
|
<span style="color:green;">// a. Select a vault view.</span>
|
|
<span style="color:green;">// b. Click <b>Copy file</b>.</span>
|
|
<span style="color:green;">// 1. In the Open dialog, click a vault file.</span>
|
|
<span style="color:green;">// 2. Click <b>Open</b>.</span>
|
|
<span style="color:green;">// 3. In the Select Folder dialog, click a different folder to which to </span>
|
|
<span style="color:green;">// </span><span style="color:green;">copy </span><span style="color:green;">the selected file.</span>
|
|
<span style="color:green;">// 4. Click <b>OK</b>.</span>
|
|
<span style="color:green;">// 5. Displays a message with the file copy status.</span>
|
|
<span style="color:green;">// 6. Click <b>OK</b>.</span>
|
|
<span style="color:green;">// 2. Close the Copy file dialog box. </span>
|
|
<span style="color:green;">//----------------------------------------------------------------------------</span></pre>
|
|
<pre style="font-family: Courier New; font-size: 13; color: black; background: white"><span style="color: #008000"><a name="Form1"></a>//Form1.cs</span>
|
|
|
|
<span style="color:blue;">using</span> System;
|
|
<span style="color:blue;">using</span> System.Collections.Generic;
|
|
<span style="color:blue;">using</span> System.ComponentModel;
|
|
<span style="color:blue;">using</span> System.Data;
|
|
<span style="color:blue;">using</span> System.Drawing;
|
|
<span style="color:blue;">using</span> System.Linq;
|
|
<span style="color:blue;">using</span> System.Text;
|
|
<span style="color:blue;">using</span> System.Windows.Forms;
|
|
<span style="color:blue;">using</span> EPDM.Interop.epdm;
|
|
<span style="color:blue;">using</span> EPDM.Interop.EPDMResultCode;
|
|
|
|
|
|
<span style="color:blue;">namespace</span> VaultUtilities_CSharp
|
|
{
|
|
<span style="color:blue;">public</span> <span style="color:blue;">partial</span> <span style="color:blue;">class</span> <span style="color:#2b91af;">Form1</span> : <span style="color:#2b91af;">Form</span>
|
|
{
|
|
<span style="color:blue;">public</span> Form1()
|
|
{
|
|
InitializeComponent();
|
|
}
|
|
<span style="color:blue;">private</span> <span style="color:#2b91af;">IEdmVault5</span> vault1 = <span style="color:blue;">null</span>;
|
|
|
|
<span style="color:blue;">public</span> <span style="color:blue;">void</span> Form1_Load(System.<span style="color:#2b91af;">Object</span> sender, System.<span style="color:#2b91af;">EventArgs</span> e)
|
|
{
|
|
<span style="color:blue;">try</span>
|
|
{
|
|
<span style="color:#2b91af;">IEdmVault5</span> vault1 = <span style="color:blue;">new</span> <span style="color:#2b91af;">EdmVault5</span>();
|
|
<span style="color:#2b91af;">IEdmVault8</span> vault = (<span style="color:#2b91af;">IEdmVault8</span>)vault1;
|
|
<span style="color:#2b91af;">EdmViewInfo</span>[] Views = <span style="color:blue;">null</span>;
|
|
|
|
vault.<b>GetVaultViews</b>(<span style="color:blue;">out</span> Views, <span style="color:blue;">false</span>);
|
|
VaultsComboBox.Items.Clear();
|
|
<span style="color:blue;">foreach</span> (<span style="color:#2b91af;">EdmViewInfo</span> View <span style="color:blue;">in</span> Views)
|
|
{
|
|
VaultsComboBox.Items.Add(View.<b>mbsVaultName</b>);
|
|
}
|
|
<span style="color:blue;">if</span> (VaultsComboBox.Items.Count > 0)
|
|
{
|
|
VaultsComboBox.Text = (<span style="color:blue;">string</span>)VaultsComboBox.Items[0];
|
|
}
|
|
}
|
|
<span style="color:blue;">catch</span> (System.Runtime.InteropServices.<span style="color:#2b91af;">COMException</span> ex)
|
|
{
|
|
<span style="color:#2b91af;">MessageBox</span>.Show(<span style="color:#a31515;">"HRESULT = 0x"</span> + ex.ErrorCode.ToString(<span style="color:#a31515;">"X"</span>) + <span style="color:#a31515;">" "</span> + ex.Message);
|
|
}
|
|
<span style="color:blue;">catch</span> (<span style="color:#2b91af;">Exception</span> ex)
|
|
{
|
|
<span style="color:#2b91af;">MessageBox</span>.Show(ex.Message);
|
|
}
|
|
}
|
|
|
|
<span style="color:blue;">private</span> <span style="color:blue;">void</span> Button1_Click(System.<span style="color:#2b91af;">Object</span> sender, System.<span style="color:#2b91af;">EventArgs</span> e)
|
|
{
|
|
<span style="color:green;">//Copy file</span>
|
|
|
|
<span style="color:blue;">try</span>
|
|
{
|
|
<span style="color:#2b91af;">IEdmVault7</span> vault2 = <span style="color:blue;">null</span>;
|
|
<span style="color:blue;">if</span> (vault1 == <span style="color:blue;">null</span>)
|
|
{
|
|
vault1 = <span style="color:blue;">new</span> <span style="color:#2b91af;">EdmVault5</span>();
|
|
}
|
|
vault2 = (<span style="color:#2b91af;">IEdmVault7</span>)vault1;
|
|
<span style="color:blue;">if</span> (!vault1.<b>IsLoggedIn</b>)
|
|
{
|
|
<span style="color:green;">//Log into selected vault as the current user</span>
|
|
vault1.<b>LoginAuto</b>(VaultsComboBox.Text, <span style="color:blue;">this</span>.Handle.ToInt32());
|
|
}
|
|
|
|
<span style="color:#2b91af;">EdmStrLst5</span> pathList = <span style="color:blue;">default</span>(<span style="color:#2b91af;">EdmStrLst5</span>);
|
|
pathList = vault2.<b>BrowseForFile</b>(<span style="color:blue;">this</span>.Handle.ToInt32(), (<span style="color:blue;">int</span>)<span style="color:#2b91af;">EdmBrowseFlag</span>.EdmBws_ForOpen + (<span style="color:blue;">int</span>)<span style="color:#2b91af;">EdmBrowseFlag</span>.EdmBws_PermitVaultFiles);
|
|
<span style="color:blue;">if</span> (pathList == <span style="color:blue;">null</span>)
|
|
<span style="color:blue;">return</span>;
|
|
|
|
<span style="color:#2b91af;">IEdmFile5</span> file = <span style="color:blue;">default</span>(<span style="color:#2b91af;">IEdmFile5</span>);
|
|
<span style="color:#2b91af;">IEdmFolder5</span> srcFolder = <span style="color:blue;">null</span>;
|
|
file = vault2.<b>GetFileFromPath</b>(pathList.<b>GetNext</b>(pathList.<b>GetHeadPosition</b>()), <span style="color:blue;">out</span> srcFolder);
|
|
|
|
<span style="color:#2b91af;">IEdmFolder5</span> destFolder1 = <span style="color:blue;">default</span>(<span style="color:#2b91af;">IEdmFolder5</span>);
|
|
destFolder1 = vault2.<b>BrowseForFolder</b>(<span style="color:blue;">this</span>.Handle.ToInt32(), <span style="color:#a31515;">"Select destination folder:"</span>);
|
|
<span style="color:blue;">if</span> (destFolder1 == <span style="color:blue;">null</span>)
|
|
<span style="color:blue;">return</span>;
|
|
|
|
<span style="color:#2b91af;">IEdmFolder8</span> destFolder = (<span style="color:#2b91af;">IEdmFolder8</span>)destFolder1;
|
|
|
|
<span style="color:blue;">int</span> fileID = 0;
|
|
<span style="color:blue;">int</span> copyFileStatus;
|
|
fileID = destFolder.<b>CopyFile2</b>(file.<b>ID</b>, srcFolder.<b>ID</b>, <span style="color:blue;">this</span>.Handle.ToInt32(), <span style="color:blue;">out</span> copyFileStatus, <span style="color:#a31515;">""</span>, (<span style="color:blue;">int</span>)<span style="color:#2b91af;">EdmCopyFlag</span>.EdmCpy_Simple);
|
|
<span style="color:blue;">switch</span> (copyFileStatus)
|
|
{
|
|
<span style="color:blue;">case</span> (<span style="color:blue;">int</span>)<span style="color:#2b91af;">EdmResultSuccessCodes_e</span>.S_EDM_FILES_NOT_UNIQUE_GLOBALLY:
|
|
<span style="color:#2b91af;">MessageBox</span>.Show(<span style="color:#a31515;">"WARNING: File is not unique in the vault, but the file was copied to a new file with a file ID of "</span> + fileID + <span style="color:#a31515;">"."</span>);
|
|
<span style="color:blue;">break</span>;
|
|
<span style="color:blue;">case</span> 0:
|
|
<span style="color:#2b91af;">MessageBox</span>.Show(<span style="color:#a31515;">"SUCCESS: File copied to a new file with a file ID of "</span> + fileID + <span style="color:#a31515;">"."</span>);
|
|
<span style="color:blue;">break</span>;
|
|
}
|
|
}
|
|
<span style="color:blue;">catch</span> (System.Runtime.InteropServices.<span style="color:#2b91af;">COMException</span> ex)
|
|
{
|
|
<span style="color:#2b91af;">MessageBox</span>.Show(<span style="color:#a31515;">"HRESULT = 0x"</span> + ex.ErrorCode.ToString(<span style="color:#a31515;">"X"</span>) + <span style="color:#a31515;">" "</span> + ex.Message);
|
|
}
|
|
<span style="color:blue;">catch</span> (<span style="color:#2b91af;">Exception</span> ex)
|
|
{
|
|
<span style="color:#2b91af;">MessageBox</span>.Show(ex.Message);
|
|
}
|
|
}
|
|
}
|
|
}</pre>
|
|
<pre style="font-family: Courier New; font-size: 13; color: black; background: white"><font color="#008000"><a name="Form1Designer"></a>//Form1.Designer.cs</font></pre>
|
|
<pre style="font-family: Courier New; font-size: 13; color: black; background: white"><span style="color:blue;">namespace</span> VaultUtilities_CSharp
|
|
{
|
|
<span style="color:blue;">partial</span> <span style="color:blue;">class</span> <span style="color:#2b91af;">Form1</span>
|
|
{
|
|
<span style="color:gray;">///</span><span style="color:green;"> </span><span style="color:gray;"><summary></span>
|
|
<span style="color:gray;">///</span><span style="color:green;"> Required designer variable.</span>
|
|
<span style="color:gray;">///</span><span style="color:green;"> </span><span style="color:gray;"></summary></span>
|
|
<span style="color:blue;">private</span> System.ComponentModel.<span style="color:#2b91af;">IContainer</span> components = <span style="color:blue;">null</span>;
|
|
|
|
<span style="color:gray;">///</span><span style="color:green;"> </span><span style="color:gray;"><summary></span>
|
|
<span style="color:gray;">///</span><span style="color:green;"> Clean up any resources being used.</span>
|
|
<span style="color:gray;">///</span><span style="color:green;"> </span><span style="color:gray;"></summary></span>
|
|
<span style="color:gray;">///</span><span style="color:green;"> </span><span style="color:gray;"><param name="disposing"></span><span style="color:green;">true if managed resources should be disposed; otherwise, false.</span><span style="color:gray;"></param></span>
|
|
<span style="color:blue;">protected</span> <span style="color:blue;">override</span> <span style="color:blue;">void</span> Dispose(<span style="color:blue;">bool</span> disposing)
|
|
{
|
|
<span style="color:blue;">if</span> (disposing && (components != <span style="color:blue;">null</span>))
|
|
{
|
|
components.Dispose();
|
|
}
|
|
<span style="color:blue;">base</span>.Dispose(disposing);
|
|
}
|
|
|
|
<span style="color:blue;"> #region</span> Windows Form Designer generated code
|
|
|
|
<span style="color:gray;">///</span><span style="color:green;"> </span><span style="color:gray;"><summary></span>
|
|
<span style="color:gray;">///</span><span style="color:green;"> Required method for Designer support - do not modify</span>
|
|
<span style="color:gray;">///</span><span style="color:green;"> the contents of this method with the code editor.</span>
|
|
<span style="color:gray;">///</span><span style="color:green;"> </span><span style="color:gray;"></summary></span>
|
|
<span style="color:blue;">private</span> <span style="color:blue;">void</span> InitializeComponent()
|
|
{
|
|
<span style="color:blue;">this</span>.VaultsLabel = <span style="color:blue;">new</span> System.Windows.Forms.<span style="color:#2b91af;">Label</span>();
|
|
<span style="color:blue;">this</span>.VaultsComboBox = <span style="color:blue;">new</span> System.Windows.Forms.<span style="color:#2b91af;">ComboBox</span>();
|
|
<span style="color:blue;">this</span>.Button1 = <span style="color:blue;">new</span> System.Windows.Forms.<span style="color:#2b91af;">Button</span>();
|
|
<span style="color:blue;">this</span>.OpenFileDialog1 = <span style="color:blue;">new</span> System.Windows.Forms.<span style="color:#2b91af;">OpenFileDialog</span>();
|
|
<span style="color:blue;">this</span>.SuspendLayout();
|
|
<span style="color:green;">// </span>
|
|
<span style="color:green;">// VaultsLabel</span>
|
|
<span style="color:green;">// </span>
|
|
<span style="color:blue;">this</span>.VaultsLabel.AutoSize = <span style="color:blue;">true</span>;
|
|
<span style="color:blue;">this</span>.VaultsLabel.Location = <span style="color:blue;">new</span> System.Drawing.<span style="color:#2b91af;">Point</span>(13, 26);
|
|
<span style="color:blue;">this</span>.VaultsLabel.Name = <span style="color:#a31515;">"VaultsLabel"</span>;
|
|
<span style="color:blue;">this</span>.VaultsLabel.Size = <span style="color:blue;">new</span> System.Drawing.<span style="color:#2b91af;">Size</span>(94, 13);
|
|
<span style="color:blue;">this</span>.VaultsLabel.TabIndex = 0;
|
|
<span style="color:blue;">this</span>.VaultsLabel.Text = <span style="color:#a31515;">" Select vault view:"</span>;
|
|
<span style="color:green;">// </span>
|
|
<span style="color:green;">// VaultsComboBox</span>
|
|
<span style="color:green;">// </span>
|
|
<span style="color:blue;">this</span>.VaultsComboBox.FormattingEnabled = <span style="color:blue;">true</span>;
|
|
<span style="color:blue;">this</span>.VaultsComboBox.Location = <span style="color:blue;">new</span> System.Drawing.<span style="color:#2b91af;">Point</span>(16, 42);
|
|
<span style="color:blue;">this</span>.VaultsComboBox.Name = <span style="color:#a31515;">"VaultsComboBox"</span>;
|
|
<span style="color:blue;">this</span>.VaultsComboBox.Size = <span style="color:blue;">new</span> System.Drawing.<span style="color:#2b91af;">Size</span>(121, 21);
|
|
<span style="color:blue;">this</span>.VaultsComboBox.TabIndex = 1;
|
|
<span style="color:green;">// </span>
|
|
<span style="color:green;">// Button1</span>
|
|
<span style="color:green;">// </span>
|
|
<span style="color:blue;">this</span>.Button1.Location = <span style="color:blue;">new</span> System.Drawing.<span style="color:#2b91af;">Point</span>(16, 82);
|
|
<span style="color:blue;">this</span>.Button1.Name = <span style="color:#a31515;">"Button1"</span>;
|
|
<span style="color:blue;">this</span>.Button1.Size = <span style="color:blue;">new</span> System.Drawing.<span style="color:#2b91af;">Size</span>(66, 23);
|
|
<span style="color:blue;">this</span>.Button1.TabIndex = 6;
|
|
<span style="color:blue;">this</span>.Button1.Text = <span style="color:#a31515;">"Copy file"</span>;
|
|
<span style="color:blue;">this</span>.Button1.TextAlign = System.Drawing.<span style="color:#2b91af;">ContentAlignment</span>.MiddleLeft;
|
|
<span style="color:blue;">this</span>.Button1.UseVisualStyleBackColor = <span style="color:blue;">true</span>;
|
|
<span style="color:blue;">this</span>.Button1.Click += <span style="color:blue;">new</span> System.<span style="color:#2b91af;">EventHandler</span>(<span style="color:blue;">this</span>.Button1_Click);
|
|
<span style="color:green;">// </span>
|
|
<span style="color:green;">// OpenFileDialog1</span>
|
|
<span style="color:green;">// </span>
|
|
<span style="color:blue;">this</span>.OpenFileDialog1.FileName = <span style="color:#a31515;">"OpenFileDialog1"</span>;
|
|
<span style="color:green;">// </span>
|
|
<span style="color:green;">// Form1</span>
|
|
<span style="color:green;">// </span>
|
|
<span style="color:blue;">this</span>.AutoScaleDimensions = <span style="color:blue;">new</span> System.Drawing.<span style="color:#2b91af;">SizeF</span>(6F, 13F);
|
|
<span style="color:blue;">this</span>.AutoScaleMode = System.Windows.Forms.<span style="color:#2b91af;">AutoScaleMode</span>.Font;
|
|
<span style="color:blue;">this</span>.ClientSize = <span style="color:blue;">new</span> System.Drawing.<span style="color:#2b91af;">Size</span>(197, 140);
|
|
<span style="color:blue;">this</span>.Controls.Add(<span style="color:blue;">this</span>.Button1);
|
|
<span style="color:blue;">this</span>.Controls.Add(<span style="color:blue;">this</span>.VaultsComboBox);
|
|
<span style="color:blue;">this</span>.Controls.Add(<span style="color:blue;">this</span>.VaultsLabel);
|
|
<span style="color:blue;">this</span>.Name = <span style="color:#a31515;">"Form1"</span>;
|
|
<span style="color:blue;">this</span>.Text = <span style="color:#a31515;">"Copy file"</span>;
|
|
<span style="color:blue;">this</span>.Load += <span style="color:blue;">new</span> System.<span style="color:#2b91af;">EventHandler</span>(<span style="color:blue;">this</span>.Form1_Load);
|
|
<span style="color:blue;">this</span>.ResumeLayout(<span style="color:blue;">false</span>);
|
|
<span style="color:blue;">this</span>.PerformLayout();
|
|
|
|
}
|
|
|
|
<span style="color:blue;"> #endregion</span>
|
|
|
|
<span style="color:blue;">internal</span> System.Windows.Forms.<span style="color:#2b91af;">Label</span> VaultsLabel;
|
|
<span style="color:blue;">internal</span> System.Windows.Forms.<span style="color:#2b91af;">ComboBox</span> VaultsComboBox;
|
|
<span style="color:blue;">internal</span> System.Windows.Forms.<span style="color:#2b91af;">Button</span> Button1;
|
|
<span style="color:blue;">internal</span> System.Windows.Forms.<span style="color:#2b91af;">OpenFileDialog</span> OpenFileDialog1;
|
|
}
|
|
}</pre>
|
|
|
|
</body>
|
|
|
|
</html>
|