Get and Set Dictionary Key-Value Pairs Example (VB.NET)

This example shows how to access key-value pairs in a vault dictionary.

NOTE: If using the primary interop assembly provided with SOLIDWORKS PDM Professional, see Using .NET Framework 4.0 in Stand-alone Applications.

'----------------------------------------------------------------------------
' Preconditions:
' 1. Start Microsoft Visual Studio.
'    a. Click File > New > Project > Visual Basic > Windows Forms Application.
'    b. Type TestDictionary 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.
' 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. Click Debug > Start Debugging or press F5.
'
' Postconditions: 
'  1. Displays a dialog.
'  2. Select a vault view.
'  3. Click Substring in key.
'  4. Click Get key-value pairs.
'     a. Displays a message box with all key-value pairs in the dictionary where
'        string key contains "at".
'     b. Click OK.
'  5. Click Integer key range.
'  6. Click Get key-value pairs.
'     a. Displays a message box with all key-value pairs in the dictionary where
'        integer keys are in the range, 13-88.
'     b. Click OK.
'  7. Click Substring in values of all integer keys.
'  8. Click Get key-value pairs.
'     a. Displays a message box with all key-value pairs in the dictionary where
'        value contains "three".
'     b. Click OK.
'  9. Click Specific integer key.
' 10. Click Get key-value pairs.
'     a. Displays a message box with the value for key, 77.
'     b. Click OK.
' 11. Click Enumeration of all integer keys.
' 12. Click Get key-value pairs.
'     a. Displays a message box with all integer key-value pairs in the dictionary.
'     b. Click OK. 
' 13. Click Delete a key-value pair.
'     a. Displays a message box notifying that key, 2, is removed.
'     b. Click OK.
' 14. Click Create a key-value pair.
'     a. Displays a message box notifying that key, 2, is created.
'     b. Click OK.
' 15. Close the dialog.
'----------------------------------------------------------------------------
 
'Form1.vb

Imports System.IO
Imports System.Xml.Serialization
Imports System.Collections
Imports System.Collections.Generic
Imports System.Data
Imports System.Diagnostics
Imports System.Windows.Forms
Imports System.ComponentModel
Imports EPDM.Interop.epdm
 
Public Class Form1
    Dim vault1 As IEdmVault5 = New EdmVault5()
    Dim vault As IEdmVault8 = DirectCast(vault1, IEdmVault8)
    Dim Views As EdmViewInfo() = Nothing
    Dim dic As IEdmDictionary5
    Public Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
 
        Try
            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 Button5_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button5.Click
        'Delete key-value pair clicked
        Try
            Dim vault2 As IEdmVault7 = Nothing
            If vault1 Is Nothing Then
                vault1 = New EdmVault5()
            End If
            vault2 = DirectCast(vault1, IEdmVault7)
 
            If Not vault1.IsLoggedIn Then
                vault1.LoginAuto(VaultsComboBox.Text, Me.Handle.ToInt32())
            End If
 
            dic = vault.GetDictionary("MyDictionary", True)
            'Add some values 
            dic.LongSetAt(2, "two")
            dic.LongSetAt(15, "fifteen")
            dic.LongSetAt(300, "three hundred")
            dic.LongSetAt(77, "seventy-seven")

            dic.LongRemoveAt(2)
            MessageBox.Show("Key 2 removed.")
            dic.RemoveDictionary()
 
        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 Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
        'Get key-value pairs clicked
        Try
            Dim vault2 As IEdmVault7 = Nothing
            If vault1 Is Nothing Then
                vault1 = New EdmVault5()
            End If
            vault2 = DirectCast(vault1, IEdmVault7)
 
            If Not vault1.IsLoggedIn Then
                vault1.LoginAuto(VaultsComboBox.Text, Me.Handle.ToInt32())
            End If
 
            If Me.RadioButton1.Checked Then
                'Get key-value pairs by substring in key
                
                dic = vault.GetDictionary("MyDictionary", True)
 
                'Add some values 
                dic.StringSetAt("Cat", "Socks")
                dic.StringSetAt("Dog", "Milou")
                dic.StringSetAt("Human", "Attila")
                dic.StringSetAt("At last", "Last value")
 
                'Find all keys containing the text, "at" 
                Dim key As String = ""
                Dim value As String = ""
                Dim message As String
                message = "Keys with 'at' in them:" + vbLf
                Dim pos As IEdmPos5
                pos = dic.StringFindKeys("at")
                While Not pos.IsNull
                    dic.StringGetNextAssoc(pos, key, value)
                    message = message + "<" + key + "> = <" + value + ">" + vbLf
                End While
 
                'Show a message and delete the dictionary 
                MsgBox(message)
                dic.RemoveDictionary()

            ElseIf Me.RadioButton2.Checked Then
                'Get key-value pairs by integer key range
                 
                dic = vault.GetDictionary("MyDictionary", True)
 
                'Add some values 
                dic.LongSetAt(2, "two")
                dic.LongSetAt(15, "fifteen")
                dic.LongSetAt(300, "three hundred")
                dic.LongSetAt(77, "seventy-seven")
 
                'Find all keys in the range, 13-88 
                Dim key As Long
                Dim value As String = ""
                Dim message As String
                message = "Keys in the range 13-88:" + vbLf
                Dim pos As IEdmPos5
                pos = dic.LongFindKeys(13, 88)
                While Not pos.IsNull
                    dic.LongGetNextAssoc(pos, key, value)
                    message = message + "<" + Str(key) + "> = <" + value + ">" + vbLf
                End While
 
                'Show a message and delete the dictionary 
                MsgBox(message)
                dic.RemoveDictionary()
         
            ElseIf Me.RadioButton3.Checked Then
                'Get key-value pairs by substring in values of integer keys

                dic = vault.GetDictionary("MyDictionary", True)
                'Add some values 
                dic.LongSetAt(2, "two")
                dic.LongSetAt(15, "fifteen")
                dic.LongSetAt(300, "three hundred")
                dic.LongSetAt(77, "seventy-seven")

                Dim bsValueSubString As String = "three"
                Dim aPos As IEdmPos5
                Dim plRetKey As Integer
                Dim pbsRetValue As String = ""
                aPos = dic.LongFindValues(bsValueSubString)
                While Not aPos.IsNull
                    dic.LongGetNextAssoc(aPos, plRetKey, pbsRetValue)
                    MessageBox.Show("Key-value pair with " & """" & bsValueSubString & """" & " in value: " & vbLf & "<" & plRetKey & "> = <" & pbsRetValue & ">")
                End While
                dic.RemoveDictionary()

            ElseIf Me.RadioButton4.Checked Then
                'Get key-value pairs by specific integer key

                dic = vault.GetDictionary("MyDictionary", True)
                'Add some values 
                dic.LongSetAt(2, "two")
                dic.LongSetAt(15, "fifteen")
                dic.LongSetAt(300, "three hundred")
                dic.LongSetAt(77, "seventy-seven")

                Dim pbsRetValue As String = ""
                dic.LongGetAt(77, pbsRetValue)
                MessageBox.Show("Value for key 77: " & pbsRetValue)
                dic.RemoveDictionary()

            ElseIf Me.RadioButton5.Checked Then
                'Get key-value pairs by enumeration of all integer keys
                
                dic = vault.GetDictionary("MyDictionary", True)
                'Add some values
                dic.LongSetAt(2, "two")
                dic.LongSetAt(15, "fifteen")
                dic.LongSetAt(300, "three hundred")
                dic.LongSetAt(77, "seventy-seven")
 
                Dim msg As String
                Dim key As Long
                Dim value As String = ""
 
                msg = "Integer keys in dictionary:" + vbLf
 
                Dim pos As IEdmPos5
                pos = dic.LongGetFirstPosition
                While Not pos.IsNull
                    dic.LongGetNextAssoc(pos, key, value)
                    msg = msg + "<" + Str(key) + "> = <" + value + ">" + vbLf
                End While
                MsgBox(msg)
                dic.RemoveDictionary()
         
            Else
                MessageBox.Show("Select how to get key-value pairs.")
                
            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 Button7_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button7.Click
        'Create key-value pair clicked
        Try
            Dim vault2 As IEdmVault7 = Nothing
            If vault1 Is Nothing Then
                vault1 = New EdmVault5()
            End If
            vault2 = DirectCast(vault1, IEdmVault7)
 
            If Not vault1.IsLoggedIn Then
                vault1.LoginAuto(VaultsComboBox.Text, Me.Handle.ToInt32())
            End If
 
            Dim pbsRetValue As String = ""
           
            dic = vault.GetDictionary("MyDictionary", True)
            dic.LongTestAndSetAt(2, "Two")
            dic.LongGetAt(2, pbsRetValue)
            MessageBox.Show("Created:" & vbLf & "<2> = <" & pbsRetValue & ">")
            dic.RemoveDictionary()
        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
 
End Class

Back to top

'Form1.Designer.vb

Back to top