Hide Table of Contents

Prevent Admin from Checking In File Example (VB.NET)

This example shows how to prevent Admin from checking in a file that was not checked out by Admin.

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 2010.
'     a. Click File > New > Project > Visual Basic > Windows Forms Application.
'     b. Type RefItemContainerVBNET 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.vb in the Solution Explorer.
'     f. Replace the code in Form1.vb with this code.
'     g. To create the form, replace the code in Form1.Designer.vb with 
'        this code.
'     h. To create the class for the callback:
'        1. Right-click RefItemContainerVBNET in the Solution Explorer.
'        2. Click Add > Class.
'        3. Type Callback.vb in Name and click Add.
'        4. Replace the code in Callback.vb 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, click Open, click Add, and click Close).
'  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. Ensure that a file in the targeted vault is checked out by a user 
'     other than Admin.
'  5. Log into the targeted vault as Admin.
'  6. Click Debug > Start Debugging or press F5.
'
' Postconditions: 
' 1. Displays the Access Check-in Flags in Check in Dialog dialog box.
' 2. Select the vault view where you are logged in as Admin.
' 3. Click Select checked-out files to check in.
'    a. Displays the Select files dialog box.
'    b. Click the file verified as checked out by a user other than
'       Admin.
'    c. Click Open.
' 4. Click Create batch check-in
'    a. Displays message boxes with callback information.
'    b. Click OK to close each message box.
'    c. Displays a message box verifying that the batch check-in 
'       was created. 
'    d. Click OK to close the message box.
' 5. Click Update check-in flags.
'    a. Displays a message box verifying that check-in flags were updated.
'    b. Click OK to close the message box.
' 6. Click Check in files.
'    a. Displays the Check in dialog box.
'    b. Select the Check in check box.
'    c. Click the Check in button.
'    d. Displays message boxes with callback information.
'    e. Click OK to close each message box.
'    f. Displays an error message informing you that the file is not
'       checked out by Admin. 
'    g. Click OK to close the error message.
' 7. Open a Windows Explorer view of the selected vault and verify that the 
'    file that you selected to check in is still checked out.
' 8. Close the Access Check-in Flags in Check in Dialog dialog box.
'--------------------------------------------------------------------------------------
 
 
'Form1.vb
Imports System.Windows.Forms
Imports EPDM.Interop.epdm
 
 
Public Class Form1
 
    Private vault1 As IEdmVault5 = Nothing
    Private vault As IEdmVault8 = Nothing
    Private selFiles As EdmSelItem() = Nothing
    Private bUnlock As IEdmBatchUnlock = Nothing
    Private pathList As EdmStrLst5 = Nothing
    Private pos As IEdmPos5 = Nothing
    Private UnlockCallback As MyCallback
 
 
    Private Sub Form1_Load(ByVal sender As System.ObjectByVal e As System.EventArgsHandles MyBase.Load
 
        Try
            vault1 = New EdmVault5()
            vault = DirectCast(vault1, IEdmVault8)
            Dim Views As EdmViewInfo() = {}
 
            vault.GetVaultViews(Views, False)
            VaultsComboBox.Items.Clear()
            For Each View As EdmViewInfo In Views
                VaultsComboBox.Items.Add(View.mbsVaultName)
            Next
            If VaultsComboBox.Items.Count > 0 Then
                VaultsComboBox.Text = DirectCast(VaultsComboBox.Items(0), String)
            End If
        Catch ex As System.Runtime.InteropServices.COMException
            MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + " " + ex.Message)
        Catch ex As Exception
            MessageBox.Show(ex.Message)
        End Try
    End Sub
 
    Private Sub BrowseButton_Click(ByVal sender As ObjectByVal e As EventArgsHandles BrowseButton.Click
        Try
            'Only create a new vault object
            'if one hasn't been created yet
            If vault1 Is Nothing Then
                vault1 = New EdmVault5()
            End If
 
            If Not vault1.IsLoggedIn Then
                'Log into selected vault as the current user
                vault1.LoginAuto(VaultsComboBox.Text, Me.Handle.ToInt32())
            End If
 
            'Display the Select file dialog for user to
            'select the files 
            pathList = vault.BrowseForFile(Me.Handle.ToInt32(), _
                        CInt(EdmBrowseFlag.EdmBws_ForOpen) + CInt(EdmBrowseFlag.EdmBws_PermitMultipleSel) + _
                        CInt(EdmBrowseFlag.EdmBws_PermitVaultFiles), "SOLIDWORKS files " + _
                        "(*.sldprt; *.sldasm; *.slddrw)|" + "*.sldprt;*.sldasm;*.slddrw|" + _
                        "All Files (*.*)|*.*||""""", vault.RootFolderPath, _
                        "Select files")
 
            'Exit if the user clicks Cancel
            If pathList Is Nothing Then
                Return
            End If
 
            'Traverse the selected files
            pos = pathList.GetHeadPosition()
 
            'Convert the selected files to an
            'array of EdmSelItem structs
            Dim nbrFiles As Integer = 0
            nbrFiles = pathList.Count
            Array.Resize(selFiles, nbrFiles)
 
            Dim i As Integer = 0
            While Not pos.IsNull
                'Get each file path from the selected files list
                Dim filePath As String = Nothing
                Dim file As IEdmFile5 = Nothing
                Dim retFolder As IEdmFolder5 = Nothing
                filePath = pathList.GetNext(pos)
                file = vault.GetFileFromPath(filePath, retFolder)
                selFiles(i).mlDocID = file.ID
                selFiles(i).mlProjID = retFolder.ID
                i = i + 1
 
            End While
 
        Catch ex As System.Runtime.InteropServices.COMException
            MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + vbLf + ex.Message)
        Catch ex As Exception
            MessageBox.Show(ex.Message)
        End Try
 
    End Sub
 
    Private Sub CreateBatchCheckinButton_Click(ByVal sender As ObjectByVal e As EventArgsHandles CreateBatchCheckinButton.Click
        Try
            'Only create a new vault object
            'if one hasn't been created yet
            If vault1 Is Nothing Then
                vault1 = New EdmVault5()
            End If
 
            If Not vault1.IsLoggedIn Then
                'Log into selected vault as the current user
                vault1.LoginAuto(VaultsComboBox.Text, Me.Handle.ToInt32())
            End If
 
            Dim vault2 As IEdmVault7 = DirectCast(vault1, IEdmVault7)
            bUnlock = DirectCast(vault2.CreateUtility(EdmUtility.EdmUtil_BatchUnlock), IEdmBatchUnlock)
            bUnlock.AddSelection(DirectCast(vault1, EdmVault5), selFiles)
            Dim tree As Boolean = False
 
            Dim UnlockCallback = New MyCallback
            tree = bUnlock.CreateTree(Me.Handle.ToInt32(), CInt(EdmUnlockBuildTreeFlags.Eubtf_MayUnlock), _
                    UnlockCallback)
 
            If tree = False Then
                MessageBox.Show("No checked-out files selected to check in. Please try again.")
                Return
            End If
 
 
            MessageBox.Show("Batch check-in created.")
        Catch ex As System.Runtime.InteropServices.COMException
            MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + vbLf + ex.Message)
        Catch ex As Exception
            MessageBox.Show(ex.Message)
        End Try
    End Sub
 
    Private Sub UpdateBatchCheckInButton_Click(ByVal sender As ObjectByVal e As EventArgsHandles UpdateBatchCheckInButton.Click
        Try
            'Only create a new vault object
            'if one hasn't been created yet
            If vault1 Is Nothing Then
                vault1 = New EdmVault5()
            End If
 
            If Not vault1.IsLoggedIn Then
                'Log into selected vault as the current user
                vault1.LoginAuto(VaultsComboBox.Text, Me.Handle.ToInt32())
            End If
            Dim container As IEdmRefItemContainer = Nothing
            If IsNothing(bUnlock) Then
                MessageBox.Show("No checked-out files selected to check in. Please try again.")
                Exit Sub
            Else 
                container = DirectCast(bUnlock, IEdmRefItemContainer)
                Dim items As Object() = Nothing
                Dim theItem As IEdmRefItem = Nothing
                container.GetItems(EdmRefItemType.Edmrit_All, items)
                Dim j As Integer = 0
                While j < items.Length
                    Dim aItem As IEdmRefItem = Nothing
                    theItem = DirectCast(items(j), IEdmRefItem)
                    aItem = theItem
                    Dim value As Object = Nothing
                    aItem.SetProperty(EdmRefItemProperty.Edmrip_CheckKeepLocked, value)
                    j = j + 1
                End While
            End If
 
            MessageBox.Show("Check-in flags updated.")
 
        Catch ex As System.Runtime.InteropServices.COMException
            MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + vbLf + ex.Message)
        Catch ex As Exception
            MessageBox.Show(ex.Message)
        End Try
 
    End Sub
 
    Private Sub CheckInButton_Click(ByVal sender As ObjectByVal e As EventArgsHandles CheckInButton.Click
        Try
            'Only create a new vault object
            'if one hasn't been created yet
            If vault1 Is Nothing Then
                vault1 = New EdmVault5()
            End If
 
            If Not vault1.IsLoggedIn Then
                'Log into selected vault as the current user
                vault1.LoginAuto(VaultsComboBox.Text, Me.Handle.ToInt32())
            End If
            If IsNothing(bUnlock) Then
                MessageBox.Show("No checked-out files selected to check in. Please try again.")
                Exit Sub
            Else
                Dim UnlockCallback = New MyCallback
                If bUnlock.ShowDlg(Me.Handle.ToInt32()) Then
                    bUnlock.UnlockFiles(Me.Handle.ToInt32(), UnlockCallback)
                End If
            End If
 
        Catch ex As System.Runtime.InteropServices.COMException
            MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + vbLf + ex.Message)
        Catch ex As Exception
            MessageBox.Show(ex.Message)
        End Try
    End Sub
 
End Class
'Form1.Designer.vb
<Global.Microsoft.VisualBasic.CompilerServices.DesignerGenerated()> _
Partial Class Form1
    Inherits System.Windows.Forms.Form
 
    'Form overrides dispose to clean up the component list.
    <System.Diagnostics.DebuggerNonUserCode()> _
    Protected Overrides Sub Dispose(ByVal disposing As Boolean)
        Try
            If disposing AndAlso components IsNot Nothing Then
                components.Dispose()
            End If
        Finally
            MyBase.Dispose(disposing)
        End Try
    End Sub
 
    'Required by the Windows Form Designer
    Private components As System.ComponentModel.IContainer
 
    'NOTE: The following procedure is required by the Windows Form Designer
    'It can be modified using the Windows Form Designer.  
    'Do not modify it using the code editor.
    <System.Diagnostics.DebuggerStepThrough()> _
    Private Sub InitializeComponent()
        Me.VaultsLabel = New System.Windows.Forms.Label()
        Me.VaultsComboBox = New System.Windows.Forms.ComboBox()
        Me.BrowseButton = New System.Windows.Forms.Button()
        Me.CreateBatchCheckinButton = New System.Windows.Forms.Button()
        Me.UpdateBatchCheckInButton = New System.Windows.Forms.Button()
        Me.CheckInButton = New System.Windows.Forms.Button()
        Me.SuspendLayout()
        '
        'VaultsLabel
        '
        Me.VaultsLabel.AutoSize = True
        Me.VaultsLabel.Location = New System.Drawing.Point(22, 26)
        Me.VaultsLabel.Name = "VaultsLabel"
        Me.VaultsLabel.Size = New System.Drawing.Size(91, 13)
        Me.VaultsLabel.TabIndex = 0
        Me.VaultsLabel.Text = "Select view vault:"
        '
        'VaultsComboBox
        '
        Me.VaultsComboBox.FormattingEnabled = True
        Me.VaultsComboBox.Location = New System.Drawing.Point(25, 54)
        Me.VaultsComboBox.Name = "VaultsComboBox"
        Me.VaultsComboBox.Size = New System.Drawing.Size(199, 21)
        Me.VaultsComboBox.TabIndex = 1
        '
        'BrowseButton
        '
        Me.BrowseButton.Location = New System.Drawing.Point(25, 81)
        Me.BrowseButton.Name = "BrowseButton"
        Me.BrowseButton.Size = New System.Drawing.Size(199, 23)
        Me.BrowseButton.TabIndex = 2
        Me.BrowseButton.Text = "Select checked-out files to check in"
        Me.BrowseButton.TextAlign = System.Drawing.ContentAlignment.MiddleLeft
        Me.BrowseButton.UseVisualStyleBackColor = True
        '
        'CreateBatchCheckinButton
        '
        Me.CreateBatchCheckinButton.Location = New System.Drawing.Point(25, 110)
        Me.CreateBatchCheckinButton.Name = "CreateBatchCheckinButton"
        Me.CreateBatchCheckinButton.Size = New System.Drawing.Size(199, 23)
        Me.CreateBatchCheckinButton.TabIndex = 3
        Me.CreateBatchCheckinButton.Text = "Create batch check-in"
        Me.CreateBatchCheckinButton.TextAlign = System.Drawing.ContentAlignment.MiddleLeft
        Me.CreateBatchCheckinButton.UseVisualStyleBackColor = True
        '
        'UpdateBatchCheckInButton
        '
        Me.UpdateBatchCheckInButton.Location = New System.Drawing.Point(25, 139)
        Me.UpdateBatchCheckInButton.Name = "UpdateBatchCheckInButton"
        Me.UpdateBatchCheckInButton.Size = New System.Drawing.Size(199, 23)
        Me.UpdateBatchCheckInButton.TabIndex = 4
        Me.UpdateBatchCheckInButton.Text = "Update check-in flags"
        Me.UpdateBatchCheckInButton.TextAlign = System.Drawing.ContentAlignment.MiddleLeft
        Me.UpdateBatchCheckInButton.UseVisualStyleBackColor = True
        '
        'CheckInButton
        '
        Me.CheckInButton.Location = New System.Drawing.Point(25, 168)
        Me.CheckInButton.Name = "CheckInButton"
        Me.CheckInButton.Size = New System.Drawing.Size(199, 23)
        Me.CheckInButton.TabIndex = 5
        Me.CheckInButton.Text = "Check in files"
        Me.CheckInButton.TextAlign = System.Drawing.ContentAlignment.MiddleLeft
        Me.CheckInButton.UseVisualStyleBackColor = True
        '
        'Form1
        '
        Me.AutoScaleDimensions = New System.Drawing.SizeF(6.0!, 13.0!)
        Me.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font
        Me.ClientSize = New System.Drawing.Size(355, 222)
        Me.Controls.Add(Me.CheckInButton)
        Me.Controls.Add(Me.UpdateBatchCheckInButton)
        Me.Controls.Add(Me.CreateBatchCheckinButton)
        Me.Controls.Add(Me.BrowseButton)
        Me.Controls.Add(Me.VaultsComboBox)
        Me.Controls.Add(Me.VaultsLabel)
        Me.Name = "Form1"
        Me.Text = "Access Check-in Flags in Check in Dialog"
        Me.ResumeLayout(False)
        Me.PerformLayout()
 
    End Sub
    Friend WithEvents VaultsLabel As System.Windows.Forms.Label
    Friend WithEvents VaultsComboBox As System.Windows.Forms.ComboBox
    Friend WithEvents BrowseButton As System.Windows.Forms.Button
    Friend WithEvents CreateBatchCheckinButton As System.Windows.Forms.Button
    Friend WithEvents UpdateBatchCheckInButton As System.Windows.Forms.Button
    Friend WithEvents CheckInButton As System.Windows.Forms.Button
 
End Class
'Callback.vb
Imports EPDM.Interop.epdm
 
Public Class MyCallback
    Implements IEdmUnlockOpCallback
 
    Public Function MsgBox(ByVal eMsg As EPDM.Interop.epdm.EdmUnlockOpMsgByVal lDocID As IntegerByVal lProjID As IntegerByVal bsPath As StringByRef poError As EPDM.Interop.epdm.EdmUnlockErrInfoAs EPDM.Interop.epdm.EdmUnlockOpReply Implements EPDM.Interop.epdm.IEdmUnlockOpCallback.MsgBox
        Dim unlockErr As EdmUnlockErrInfo
        unlockErr = poError
        MessageBox.Show("MsgBox callback: " + vbLf + "  Document ID: " + unlockErr.mlDocID.ToString + vbLf + "  Configuration: " + unlockErr.mbsConfigName + vbLf + "  Unique ID of variable that caused error: " + unlockErr.mlVarID.ToString + vbLf + "  Name of unique variable that caused error: " + unlockErr.mbsVarName)
        Return EdmUnlockOpMsg.Euom_AdminUnlock
    End Function
 
    Public Sub ProgressBegin(ByVal eType As EPDM.Interop.epdm.EdmProgressTypeByVal eEvent As EPDM.Interop.epdm.EdmUnlockEventByVal lSteps As IntegerImplements EPDM.Interop.epdm.IEdmUnlockOpCallback.ProgressBegin
        MessageBox.Show("ProgressBegin callback: " + vbLf + "  Type of progress bar: " + eType.ToString + vbLf + "  Type of operation: " + eEvent.ToString + vbLf + "  Number of steps: " + lSteps.ToString + vbLf)
    End Sub
 
    Public Sub ProgressEnd(ByVal eType As EPDM.Interop.epdm.EdmProgressTypeImplements EPDM.Interop.epdm.IEdmUnlockOpCallback.ProgressEnd
        MessageBox.Show("Type of progress bar: " + eType.ToString + vbLf)
        Return
    End Sub
 
    Public Function ProgressStep(ByVal eType As EPDM.Interop.epdm.EdmProgressTypeByVal bsText As StringByVal lProgressPos As IntegerAs Boolean Implements EPDM.Interop.epdm.IEdmUnlockOpCallback.ProgressStep
 
        MessageBox.Show("ProgressStep callback: " + vbLf + "  Type of progress bar: " + eType.ToString + vbLf + "  Message: " + bsText + vbLf + "  New position of progress bar: " + lProgressPos.ToString)
        Return True
    End Function
 
    Public Function ProgressStepEvent(ByVal eType As EPDM.Interop.epdm.EdmProgressTypeByVal eText As EPDM.Interop.epdm.EdmUnlockEventMsgByVal lProgressPos As IntegerAs Boolean Implements EPDM.Interop.epdm.IEdmUnlockOpCallback.ProgressStepEvent
        MessageBox.Show("ProgressStepEvent callback: " + vbLf + "  Type of progress bar: " + eType.ToString + vbLf + "  Message: " + eText.ToString + vbLf + "  New position of progress bar: " + lProgressPos.ToString)
        Return True
    End Function
End Class


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   Prevent Admin from Checking In File Example (VB.NET)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:



x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2018 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.