Roll Back Revisions Example (C#)
This example shows how to roll back a checked-in file to its first revision in the current version.
NOTE: If using the .NET Framework 4.0 primary interop assembly
provided with SOLIDWORKS PDM Professional, see
Using .NET Framework 4.0 in
Stand-alone Applications.
//----------------------------------------------------------------------------
// Preconditions:
// 1. Start Microsoft Visual Studio 2015.
// a. Click File > New > Project > Visual C# > Windows Forms Application.
// b. Type RevisionCSharp in Name.
// c. Click Browse and navigate to the folder where to create the project.
// d. Click OK.
// e. Click Show All Files in the Solution Explorer toolbar and expand
// Form1.cs in the Solution Explorer.
// f. Replace the code in Form1.cs with this code.
// g. To create the form, replace the code in Form1.Designer.cs with
// this code.
// 2. Add EPDM.Interop.epdm.dll as a reference (right-click the project
// name in the Solution Explorer, click Add > Reference, click
// Assemblies > Framework in the left-side panel, browse to the top folder of
// your SOLIDWORKS PDM Professional installation, locate and click
// EPDM.Interop.epdm.dll > Add > OK).
// 3. Right-click EPDM.Interop.epdm in References, click Properties, and set
// Embed Interop Types to False to handle methods that pass arrays of
// structures.
// 4. To find a checked-in file with a revision scheme and at least three
// revisions in the current version:
// a. Open a vault view in Windows Explorer.
// b. Click a checked-in file.
// c. Click Display > History.
// d. Examine the Event column. If Revision is:
// * listed in the Event column, then the file
// has a revision scheme. Scroll down and examine the
// Event and Version columns to verify that at least three
// revisions exist for the current version of the file.
// * not listed in the Event column, then
// repeat steps 4b - 4d until you find a checked-in file
// with a revision scheme and at least three revisions for
// the current version.
// 5. Click Debug > Start Debugging or press F5.
//
// Postconditions:
// 1. Displays the Get revision names dialog box.
// 2. Select a vault view.
// 3. Click Browse.
// 4. Displays the Select a file dialog box.
// a. Click the file identified in Preconditions step 4 in the
// selected vault.
// b. Click Open to display the selected file's path and file
// name in the Get revision names dialog box.
// 5. Click Get revisions.
// 6. Displays a message box listing the names of the revisions
// for the selected file. Click OK to close the message box.
// 7. Displays a message box showing the revision to which the file
// was rolled back and the current version. Click OK to close the
// message box.
// 8. Close the Get revision names dialog box.
// 9. Click the file in the vault in Windows Explorer for which revisions
// were rolled back.
// a. Click Display > History.
// b. Scroll down and examine the Event, Version, and Comment columns.
//----------------------------------------------------------------------------
//Form1.cs
using EPDM.Interop.epdm;
using System.Windows.Forms;
using System;
namespace RevisionCSharp
{
public partial class Form1 : Form
{
public Form1()
{
InitializeComponent();
}
IEdmVault5 vault1 = null;
IEdmVault8 vault = null;
IEdmFile5 aFile;
IEdmFolder5 folder;
private void Form1_Load(System.Object sender, System.EventArgs e)
{
try
{
vault1 = new EdmVault5();
vault = (IEdmVault8)vault1;
EdmViewInfo[] Views = { };
vault.GetVaultViews(out Views, false);
VaultsComboBox.Items.Clear();
foreach (EdmViewInfo View in Views)
{
VaultsComboBox.Items.Add(View.mbsVaultName);
}
if (VaultsComboBox.Items.Count > 0)
{
VaultsComboBox.Text = (string)VaultsComboBox.Items[0];
}
}
catch (System.Runtime.InteropServices.COMException ex)
{
MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + "\n" + ex.Message);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
}
public void RevisionButton_Click(System.Object sender, System.EventArgs e)
{
try
{
//Only create a new vault object
//if one hasn't been created yet
if (vault1 == null)
{
vault1 = new EdmVault5();
}
if (!vault1.IsLoggedIn)
{
//Log into selected vault as the current user
vault1.LoginAuto(VaultsComboBox.Text, this.Handle.ToInt32());
}
//Get the local version number
int version = 0;
version = aFile.GetLocalVersionNo(folder.ID);
if (version < 1)
{
MessageBox.Show("A local copy of " + aFile.Name + " does not exist.");
return;
}
//Get the version interface
IEdmEnumeratorVersion7 verEnum = default(IEdmEnumeratorVersion7);
verEnum = (IEdmEnumeratorVersion7)aFile;
IEdmVersion8 ver = default(IEdmVersion8);
ver = (IEdmVersion8)verEnum.GetVersion(version);
//Enumerate the revisions
string message = null;
IEdmPos5 pos = default(IEdmPos5);
pos = ver.GetFirstRevisionPosition();
IEdmRevision7 rev = default(IEdmRevision7);
int verNbr = 0;
if (!pos.IsNull)
{
message = "The following revisions are set on " + aFile.Name + ": " + "\n";
while (!pos.IsNull)
{
rev = (IEdmRevision7)ver.GetNextRevision(pos);
message = message + " " + rev.Name + "\n";
verNbr = rev.VersionNo;
}
}
else
{
message = "A revision scheme is not defined for " + aFile.Name + "." + "\n";
MessageBox.Show(message);
return;
}
MessageBox.Show(message);
//Roll back to first revision
pos = ver.GetFirstRevisionPosition();
rev = (IEdmRevision7)ver.GetNextRevision(pos);
ver = (IEdmVersion8)verEnum.GetVersion(version);
message = ("Roll back to revision " + rev.Name + " of version " + verNbr);
rev.Rollback3(message, true);
MessageBox.Show(message);
}
catch (System.Runtime.InteropServices.COMException ex)
{
MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + " " + ex.Message);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
}
public void BrowseButton_Click(System.Object sender, System.EventArgs e)
{
try
{
//If one hasn't been created yet
if (vault1 == null)
{
vault1 = new EdmVault5();
}
if (!vault1.IsLoggedIn)
{
//Log into selected vault as the current user
vault1.LoginAuto(VaultsComboBox.Text, this.Handle.ToInt32());
}
//Set the initial directory in the Select a file dialog
OpenFileDialog1.InitialDirectory = vault1.RootFolderPath;
//Show the Select a file dialog
System.Windows.Forms.DialogResult DialogResult;
DialogResult = OpenFileDialog1.ShowDialog();
if (!(DialogResult == System.Windows.Forms.DialogResult.OK))
{
//Do nothing
}
else
{
//Browse for a local file whose revisions you want to see
string fileName = OpenFileDialog1.FileName;
FileListBox.Items.Add(fileName);
aFile = vault1.GetFileFromPath(fileName, out folder);
}
}
catch (System.Runtime.InteropServices.COMException ex)
{
MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + " " + ex.Message);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
}
}
}
namespace RevisionCSharp
{
partial class Form1
{
/// <summary>
/// Required designer variable.
/// </summary>
private System.ComponentModel.IContainer components = null;
/// <summary>
/// Clean up any resources being used.
/// </summary>
/// <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
protected override void Dispose(bool disposing)
{
if (disposing && (components != null))
{
components.Dispose();
}
base.Dispose(disposing);
}
#region Windows Form Designer generated code
/// <summary>
/// Required method for Designer support - do not modify
/// the contents of this method with the code editor.
/// </summary>
private void InitializeComponent()
{
this.VaultsLabel = new System.Windows.Forms.Label();
this.VaultsComboBox = new System.Windows.Forms.ComboBox();
this.FileListBox = new System.Windows.Forms.ListBox();
this.BrowseButton = new System.Windows.Forms.Button();
this.RevisionButton = new System.Windows.Forms.Button();
this.OpenFileDialog1 = new System.Windows.Forms.OpenFileDialog();
this.SuspendLayout();
//
// VaultsLabel
//
this.VaultsLabel.AutoSize = true;
this.VaultsLabel.Location = new System.Drawing.Point(23, 13);
this.VaultsLabel.Name = "VaultsLabel";
this.VaultsLabel.Size = new System.Drawing.Size(91, 13);
this.VaultsLabel.TabIndex = 0;
this.VaultsLabel.Text = "Select vault view:";
//
// VaultsComboBox
//
this.VaultsComboBox.FormattingEnabled = true;
this.VaultsComboBox.Location = new System.Drawing.Point(26, 30);
this.VaultsComboBox.Name = "VaultsComboBox";
this.VaultsComboBox.Size = new System.Drawing.Size(220, 21);
this.VaultsComboBox.TabIndex = 1;
//
// FileListBox
//
this.FileListBox.FormattingEnabled = true;
this.FileListBox.Location = new System.Drawing.Point(26, 90);
this.FileListBox.Name = "FileListBox";
this.FileListBox.Size = new System.Drawing.Size(167, 17);
this.FileListBox.TabIndex = 2;
//
// BrowseButton
//
this.BrowseButton.Location = new System.Drawing.Point(199, 84);
this.BrowseButton.Name = "BrowseButton";
this.BrowseButton.Size = new System.Drawing.Size(75, 23);
this.BrowseButton.TabIndex = 3;
this.BrowseButton.Text = "Browse...";
this.BrowseButton.TextAlign = System.Drawing.ContentAlignment.MiddleLeft;
this.BrowseButton.UseVisualStyleBackColor = true;
this.BrowseButton.Click += new System.EventHandler(BrowseButton_Click);
//
// OpenFileDialog1
//
this.OpenFileDialog1.FileName = "OpenFileDialog1";
this.OpenFileDialog1.Multiselect = true;
this.OpenFileDialog1.Title = "Select a file";
//
// RevisionButton
//
this.RevisionButton.Location = new System.Drawing.Point(26, 137);
this.RevisionButton.Name = "RevisionButton";
this.RevisionButton.Size = new System.Drawing.Size(88, 23);
this.RevisionButton.TabIndex = 4;
this.RevisionButton.Text = "Get revisions";
this.RevisionButton.TextAlign = System.Drawing.ContentAlignment.MiddleLeft;
this.RevisionButton.UseVisualStyleBackColor = true;
this.RevisionButton.Click += new System.EventHandler(RevisionButton_Click);
//
// Form1
//
this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 13F);
this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
this.ClientSize = new System.Drawing.Size(284, 187);
this.Controls.Add(this.RevisionButton);
this.Controls.Add(this.BrowseButton);
this.Controls.Add(this.FileListBox);
this.Controls.Add(this.VaultsComboBox);
this.Controls.Add(this.VaultsLabel);
this.Name = "Form1";
this.Text = "Get revision names";
this.Load += new System.EventHandler(Form1_Load);
this.ResumeLayout(false);
this.PerformLayout();
}
#endregion
private System.Windows.Forms.Label VaultsLabel;
private System.Windows.Forms.ComboBox VaultsComboBox;
private System.Windows.Forms.ListBox FileListBox;
private System.Windows.Forms.Button BrowseButton;
private System.Windows.Forms.Button RevisionButton;
private System.Windows.Forms.OpenFileDialog OpenFileDialog1;
}
}