Initial Commit of the PDM project (ready for DWS migration)
This commit is contained in:
will
240
documentation/api_extracted/Create_New_Vault_Example_VBNET.htm
Normal file
240
documentation/api_extracted/Create_New_Vault_Example_VBNET.htm
Normal file
@@ -0,0 +1,240 @@
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<title>Create New Vault Example (VB.NET)</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="VB.NET examples,vaults">
|
||||
<meta name=MS-HKWD content="VB.NET examples,logins">
|
||||
<body>
|
||||
<h1><font size="1"><span style="font-weight: 400">SOLIDWORKS PDM Professional API Help</span></h1>
|
||||
<h1>Create New Vault Example (VB.NET)</h1>
|
||||
<p><a name="top"></a>This example shows how to:</p>
|
||||
<ul>
|
||||
<li class=kadov-p>Create a new vault.</li>
|
||||
<li class=kadov-p>Create a new vault view.</li>
|
||||
<li class=kadov-p>Log into the new vault.</li>
|
||||
<li class=kadov-p>Get all of the users currently logged into vault views on
|
||||
this machine.</li>
|
||||
</ul>
|
||||
<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><img border="0" src="CreateVault.gif" width="303" height="174"></p>
|
||||
|
||||
<p style="font-family: Courier New; font-size: 13; color: black; background: white" class="APICODE">
|
||||
<span style="color:green;">
|
||||
'----------------------------------------------------------------------------</span><br>
|
||||
<span style="color:green;">' Preconditions:</span><br>
|
||||
<span style="color:green;">' 1. Start Microsoft Visual Studio.</span><br>
|
||||
<span style="color:green;">' a. Click <b>File > New > Project > Visual Basic > Windows Forms Application</b>.</span><br>
|
||||
<span style="color:green;">' b. Type <b>CreateNewVault</b> in <b>Name</b>.</span><br>
|
||||
<span style="color:green;">' c. Click <b>Browse</b> and navigate to the folder where to create </span><br>
|
||||
<span style="color:green;">' the project.</span><br>
|
||||
<span style="color:green;">' d. Click <b>OK</b>. </span><br>
|
||||
<span style="color:green;">' e. Click <b>Show All Files</b> in the Solution Explorer toolbar and expand </span><br>
|
||||
<span style="color:green;">' <b>Form1.vb</b> in the Solution Explorer.</span><br>
|
||||
<span style="color:green;">' f. Replace the code in <b>Form1.vb</b> with <a href="#form1">this code</a>.</span><br>
|
||||
<span style="color:green;">' g. To create the form,
|
||||
replace the code in <b>Form1.Designer.vb</b> with <a href="#form1designer">this code</a>.</span><br>
|
||||
<span style="color:green;">' 2. Add <b>EPDM.Interop.epdm.dll</b> as a reference (right-click the project</span><br>
|
||||
<span style="color:green;">' name in the Solution Explorer, click <b>Add Reference</b>, click </span><br>
|
||||
<span style="color:green;">' <b>Assemblies > Framework</b> in the left-side panel, browse to the top folder of </span><br>
|
||||
<span style="color:green;">' your SOLIDWORKS PDM Professional installation, locate and click </span><br>
|
||||
<span style="color:green;">' <b>EPDM.Interop.epdm.dll</b>, click <b>Open</b>, click <b>Add</b>, and click <b>Close</b>).</span><br>
|
||||
<span style="color:green;">' 3. Right-click <b>EPDM.Interop.epdm</b> in References, click <b>Properties</b>, and set </span><br>
|
||||
<span style="color:green;">' <b>Embed Interop Types</b> to <b>False</b> to handle methods that pass arrays of </span><br>
|
||||
<span style="color:green;">' structures.<br>
|
||||
' 4. In the code, substitute the following parameters in IEdmVault11::CreateNewVault<br>
|
||||
' to create MyNewVault on your machine:<br>
|
||||
' * <i>database_server</i><br>
|
||||
' * <i>sql_sa_password</i> </span><br>
|
||||
<span style="color:green;">' 5. Click <b>Debug > Start Debugging</b> or press F5.</span><br>
|
||||
<span style="color:green;">'</span><br>
|
||||
<span style="color:green;">' Postconditions: </span><br>
|
||||
<span style="color:green;">' 1. Displays the Create new vault dialog box.</span><br>
|
||||
<span style="color:green;">' a. Click <b>Create and log in to
|
||||
MyNewVault</b>.<br>
|
||||
' b. After a few seconds, displays a login dialog.<br>
|
||||
' c. Type Admin's password in <b>Password</b>.<br>
|
||||
' d. Click <b>Log in</b>.<br>
|
||||
' 1. MyNewVault is created using the Default
|
||||
configuration in the root <br>
|
||||
' folder of the archive
|
||||
server.<br>
|
||||
' 2. A view of MyNewVault, accessible to all
|
||||
users, is created in <b>c:\temp</b>. <br>
|
||||
' 3. Admin is logged into MyNewVault.</span><br>
|
||||
<span style="color:green;">' e. Click <b>Get users logged
|
||||
into all vaults</b>. </span><br>
|
||||
<span style="color:green;">
|
||||
' f. Displays a dialog with all of the users currently logged
|
||||
into <br>
|
||||
' vault views on this machine.<br>
|
||||
' g. Click <b>OK</b>.</span><br>
|
||||
<span style="color:green;">
|
||||
' 2. Close the Create new vault dialog box. </span><br>
|
||||
<span style="color:green;">
|
||||
'----------------------------------------------------------------------------</span><br>
|
||||
<br>
|
||||
<span style="color:green;"><a name="form1"></a>'Form1.vb</span><br>
|
||||
</p>
|
||||
<p style="font-family: Courier New; font-size: 13; color: black; background: white" class="APICODE">
|
||||
<span style="color:blue;">Imports</span> System.Collections.Generic<br>
|
||||
<span style="color:blue;">Imports</span> System.Data<br>
|
||||
<span style="color:blue;">Imports</span> System.Diagnostics<br>
|
||||
<span style="color:blue;">Imports</span> System.Windows.Forms<br>
|
||||
<span style="color:blue;">Imports</span> System.ComponentModel<br>
|
||||
<span style="color:blue;">Imports</span> EPDM.Interop.epdm<br>
|
||||
<br>
|
||||
<br>
|
||||
<span style="color:blue;">Public</span> <span style="color:blue;">Class</span> <span style="color:#2b91af;">Form1</span><br>
|
||||
<br>
|
||||
<span style="color:blue;">Dim</span> vault1 <span style="color:blue;">As</span> <span style="color:#2b91af;">IEdmVault5</span> = <span style="color:blue;">New</span> <span style="color:#2b91af;">EdmVault5</span>()<br>
|
||||
<span style="color:blue;">Dim</span> vault2 <span style="color:blue;">As</span> <span style="color:#2b91af;">IEdmVault13</span> = <span style="color:blue;">DirectCast</span>(vault1, <span style="color:#2b91af;">IEdmVault13</span>)<br>
|
||||
<span style="color:blue;">Dim</span> vaults <span style="color:blue;">As</span> <span style="color:blue;">String</span> = <span style="color:#a31515;">""</span><br>
|
||||
<span style="color:blue;">Public</span> <span style="color:blue;">Sub</span> Form1_Load(<span style="color:blue;">ByVal</span> sender <span style="color:blue;">As</span> System.<span style="color:#2b91af;">Object</span>, <span style="color:blue;">ByVal</span> e <span style="color:blue;">As</span> System.<span style="color:#2b91af;">EventArgs</span>) <span style="color:blue;">Handles</span> <span style="color:blue;">MyBase</span>.Load<br>
|
||||
<span style="color:blue;">End</span> <span style="color:blue;">Sub</span><br>
|
||||
<br>
|
||||
<br>
|
||||
<span style="color:blue;">Public</span> <span style="color:blue;">Sub</span> GetLoggedIn_Click(<span style="color:blue;">ByVal</span> sender <span style="color:blue;">As</span> System.<span style="color:#2b91af;">Object</span>, <span style="color:blue;">ByVal</span> e <span style="color:blue;">As</span> System.<span style="color:#2b91af;">EventArgs</span>) <span style="color:blue;">Handles</span> GetLoggedIn.Click<br>
|
||||
<span style="color:green;">'Get all of the users currently logged into vault views on this machine</span><br>
|
||||
<span style="color:blue;">Try</span><br>
|
||||
<span style="color:blue;">If</span> vault1 <span style="color:blue;">Is</span> <span style="color:blue;">Nothing</span> <span style="color:blue;">Then</span><br>
|
||||
<span style="color:#2b91af;">MessageBox</span>.Show(<span style="color:#a31515;">"Click Log in"</span>)<br>
|
||||
<span style="color:blue;">Exit Sub</span><br>
|
||||
<span style="color:blue;">End</span> <span style="color:blue;">If</span><br>
|
||||
<br>
|
||||
<span style="color:blue;">Dim</span> userMgr <span style="color:blue;">As</span> <span style="color:#2b91af;">IEdmUserMgr5</span><br>
|
||||
userMgr = vault2.<b>CreateUtility</b>(<span style="color:#2b91af;">EdmUtility</span>.EdmUtil_UserMgr)<br>
|
||||
<span style="color:blue;">Dim</span> pos <span style="color:blue;">As</span> <span style="color:#2b91af;">IEdmPos5</span><br>
|
||||
pos = userMgr.<b>GetFirstLoggedInUserPosition</b>(vaults)<br>
|
||||
<br>
|
||||
<span style="color:blue;">Dim</span> userName <span style="color:blue;">As</span> <span style="color:blue;">String</span> = <span style="color:#a31515;">""</span><br>
|
||||
<span style="color:blue;">Dim</span> computerName <span style="color:blue;">As</span> <span style="color:blue;">String</span> = <span style="color:#a31515;">""</span><br>
|
||||
<span style="color:blue;">Dim</span> vaultName <span style="color:blue;">As</span> <span style="color:blue;">String</span> = <span style="color:#a31515;">""</span><br>
|
||||
<span style="color:blue;">Dim</span> loginTime <span style="color:blue;">As</span> <span style="color:blue;">Object</span> = <span style="color:blue;">Nothing</span><br>
|
||||
<br>
|
||||
<span style="color:blue;">Dim</span> message <span style="color:blue;">As</span> <span style="color:blue;">String</span><br>
|
||||
message = <span style="color:#a31515;">"The following users are logged into vault views:"</span> & vbLf & vbLf<br>
|
||||
<br>
|
||||
<span style="color:blue;">While</span> <span style="color:blue;">Not</span> pos.<b>IsNull</b><br>
|
||||
userMgr.<b>GetNextLoggedInUser</b>(pos, userName, computerName, vaultName, loginTime)<br>
|
||||
message = message & userName & <span style="color:#a31515;">" ("</span> & computerName & <span style="color:#a31515;">")"</span> & <span style="color:#a31515;">" logged in to "</span> & vaultName & <span style="color:#a31515;">" at "</span> & loginTime.ToString & vbLf<br>
|
||||
<span style="color:blue;">End</span> <span style="color:blue;">While</span><br>
|
||||
<br>
|
||||
MsgBox(message)<br>
|
||||
<br>
|
||||
<span style="color:blue;">Catch</span> ex <span style="color:blue;">As</span> System.Runtime.InteropServices.<span style="color:#2b91af;">COMException</span><br>
|
||||
<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)<br>
|
||||
<span style="color:blue;">Catch</span> ex <span style="color:blue;">As</span> <span style="color:#2b91af;">Exception</span><br>
|
||||
<span style="color:#2b91af;">MessageBox</span>.Show(ex.Message)<br>
|
||||
<span style="color:blue;">End</span> <span style="color:blue;">Try</span><br>
|
||||
<span style="color:blue;">End</span> <span style="color:blue;">Sub</span><br>
|
||||
<br>
|
||||
<span style="color:blue;">Private</span> <span style="color:blue;">Sub</span> Button1_Click(<span style="color:blue;">ByVal</span> sender <span style="color:blue;">As</span> System.<span style="color:#2b91af;">Object</span>, <span style="color:blue;">ByVal</span> e <span style="color:blue;">As</span> System.<span style="color:#2b91af;">EventArgs</span>) <span style="color:blue;">Handles</span> Button1.Click<br>
|
||||
<span style="color:green;">' Create a new vault and vault view</span><br>
|
||||
<span style="color:blue;">Try</span><br>
|
||||
vault1 = <span style="color:blue;">New</span> <span style="color:#2b91af;">EdmVault5</span>()<br>
|
||||
vault2 = <span style="color:blue;">DirectCast</span>(vault1, <span style="color:#2b91af;">IEdmVault13</span>)<br>
|
||||
<br>
|
||||
vault2.<b>CreateNewVault</b>(<span style="color:#a31515;">""</span>, <span style="color:#a31515;">""</span>, <span style="color:#a31515;">""</span>, <span style="color:#a31515;">"MyNewVault"</span>, <span style="color:#a31515;">"This is my new vault"</span>, <span style="color:#a31515;">""</span>, <span style="color:#a31515;">"<i>database_server</i>"</span>, <span style="color:#a31515;">"sa"</span>, <span style="color:#a31515;">"<i>sql_sa_password</i>"</span>, <span style="color:#a31515;">"MyNewVault"</span>, 110, <span style="color:#a31515;">""</span>, <span style="color:#2b91af;">EdmCreateVaultFlag</span>.EdmCreateVault_UseDefaultAdminPassword, <span style="color:blue;">Nothing</span>, <span style="color:#a31515;">"Default"</span>)<br>
|
||||
vault2.<b>CreateNewVaultView</b>(<span style="color:#a31515;">""</span>, <span style="color:#a31515;">""</span>, <span style="color:#a31515;">""</span>, <span style="color:#a31515;">"MyNewVault"</span>, <span style="color:#a31515;">"c:\temp"</span>, <span style="color:#2b91af;">EdmCreateVaultViewFlag</span>.EdmCreateVaultView_SharedView)<br>
|
||||
<br>
|
||||
<span style="color:blue;">Dim</span> Views <span style="color:blue;">As</span> <span style="color:#2b91af;">EdmViewInfo</span>() = <span style="color:blue;">Nothing</span><br>
|
||||
vault2.<b>GetVaultViews</b>(Views, <span style="color:blue;">False</span>)<br>
|
||||
<br>
|
||||
<span style="color:blue;">For</span> <span style="color:blue;">Each</span> View <span style="color:blue;">As</span> <span style="color:#2b91af;">EdmViewInfo</span> <span style="color:blue;">In</span> Views<br>
|
||||
vaults = vaults & View.<b>mbsVaultName</b> & vbLf<br>
|
||||
<span style="color:blue;">Next</span><br>
|
||||
<br>
|
||||
<span style="color:green;">'Log into the new vault view </span><br>
|
||||
vault2.<b>LoginAuto</b>(<span style="color:#a31515;">"MyNewVault"</span>, <span style="color:blue;">Me</span>.Handle.ToInt32())<br>
|
||||
<br>
|
||||
<span style="color:blue;">Catch</span> ex <span style="color:blue;">As</span> System.Runtime.InteropServices.<span style="color:#2b91af;">COMException</span><br>
|
||||
<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)<br>
|
||||
<span style="color:blue;">Catch</span> ex <span style="color:blue;">As</span> <span style="color:#2b91af;">Exception</span><br>
|
||||
<span style="color:#2b91af;">MessageBox</span>.Show(ex.Message)<br>
|
||||
<span style="color:blue;">End</span> <span style="color:blue;">Try</span><br>
|
||||
<span style="color:blue;">End</span> <span style="color:blue;">Sub</span><br>
|
||||
<span style="color:blue;">End</span> <span style="color:blue;">Class</span></p>
|
||||
<p style="font-family: Courier New; font-size: 13; color: black; background: white" class="APICODE">
|
||||
</p>
|
||||
<p style="font-family: Courier New; font-size: 13; color: black; background: white" class="APICODE" align="center">
|
||||
<a href="#top">Back to top</a> </p>
|
||||
<p style="font-family: Courier New; font-size: 13; color: #008000; background: white" class="APICODE">
|
||||
<a name="form1designer"></a>'Form1.Designer.vb</p>
|
||||
<p style="font-family: Courier New; font-size: 13; color: black; background: white" class="APICODE">
|
||||
<<span style="color:blue;">Global</span>.Microsoft.VisualBasic.CompilerServices.<span style="color:#2b91af;">DesignerGenerated</span>()> _<br>
|
||||
<span style="color:blue;">Partial</span> <span style="color:blue;">Class</span> <span style="color:#2b91af;">Form1</span><br>
|
||||
<span style="color:blue;">Inherits</span> System.Windows.Forms.<span style="color:#2b91af;">Form</span><br>
|
||||
<br>
|
||||
<span style="color:blue;">Private</span> components <span style="color:blue;">As</span> System.ComponentModel.<span style="color:#2b91af;">IContainer</span> = <span style="color:blue;">Nothing</span><br>
|
||||
<br>
|
||||
<span style="color:blue;">Protected</span> <span style="color:blue;">Overrides</span> <span style="color:blue;">Sub</span> Dispose(<span style="color:blue;">ByVal</span> disposing <span style="color:blue;">As</span> <span style="color:blue;">Boolean</span>)<br>
|
||||
<span style="color:blue;">If</span> disposing <span style="color:blue;">AndAlso</span> (components <span style="color:blue;">IsNot</span> <span style="color:blue;">Nothing</span>) <span style="color:blue;">Then</span><br>
|
||||
components.Dispose()<br>
|
||||
<span style="color:blue;">End</span> <span style="color:blue;">If</span><br>
|
||||
<span style="color:blue;">MyBase</span>.Dispose(disposing)<br>
|
||||
<span style="color:blue;">End</span> <span style="color:blue;">Sub</span><br>
|
||||
<br>
|
||||
<span style="color:blue;">#Region</span> <span style="color:#a31515;">"Windows Form Designer generated code"</span><br>
|
||||
<br>
|
||||
<span style="color:green;">''' <summary></span><br>
|
||||
<span style="color:green;">''' Required method for Designer support - do not modify</span><br>
|
||||
<span style="color:green;">''' the contents of this method with the code editor.</span><br>
|
||||
<span style="color:green;">''' </summary></span></p>
|
||||
<p style="font-family: Courier New; font-size: 13; color: black; background: white" class="APICODE">
|
||||
<span style="color:blue;">Private</span> <span style="color:blue;">Sub</span> InitializeComponent()<br>
|
||||
<span style="color:blue;">Me</span>.GetLoggedIn = <span style="color:blue;">New</span> System.Windows.Forms.<span style="color:#2b91af;">Button</span>()<br>
|
||||
<span style="color:blue;">Me</span>.Button1 = <span style="color:blue;">New</span> System.Windows.Forms.<span style="color:#2b91af;">Button</span>()<br>
|
||||
<span style="color:blue;">Me</span>.SuspendLayout()<br>
|
||||
<span style="color:green;">'</span><br>
|
||||
<span style="color:green;">'GetLoggedIn</span><br>
|
||||
<span style="color:green;">'</span><br>
|
||||
<span style="color:blue;">Me</span>.GetLoggedIn.Location = <span style="color:blue;">New</span> System.Drawing.<span style="color:#2b91af;">Point</span>(31, 71)<br>
|
||||
<span style="color:blue;">Me</span>.GetLoggedIn.Name = <span style="color:#a31515;">"GetLoggedIn"</span><br>
|
||||
<span style="color:blue;">Me</span>.GetLoggedIn.Size = <span style="color:blue;">New</span> System.Drawing.<span style="color:#2b91af;">Size</span>(167, 23)<br>
|
||||
<span style="color:blue;">Me</span>.GetLoggedIn.TabIndex = 5<br>
|
||||
<span style="color:blue;">Me</span>.GetLoggedIn.Text = <span style="color:#a31515;">"Get users logged into all vaults"</span><br>
|
||||
<span style="color:blue;">Me</span>.GetLoggedIn.UseVisualStyleBackColor = <span style="color:blue;">True</span><br>
|
||||
<span style="color:green;">'</span><br>
|
||||
<span style="color:green;">'Button1</span><br>
|
||||
<span style="color:green;">'</span><br>
|
||||
<span style="color:blue;">Me</span>.Button1.Location = <span style="color:blue;">New</span> System.Drawing.<span style="color:#2b91af;">Point</span>(31, 26)<br>
|
||||
<span style="color:blue;">Me</span>.Button1.Name = <span style="color:#a31515;">"Button1"</span><br>
|
||||
<span style="color:blue;">Me</span>.Button1.Size = <span style="color:blue;">New</span> System.Drawing.<span style="color:#2b91af;">Size</span>(178, 23)<br>
|
||||
<span style="color:blue;">Me</span>.Button1.TabIndex = 6<br>
|
||||
<span style="color:blue;">Me</span>.Button1.Text = <span style="color:#a31515;">"Create and log in to MyNewVault"</span><br>
|
||||
<span style="color:blue;">Me</span>.Button1.UseVisualStyleBackColor = <span style="color:blue;">True</span><br>
|
||||
<span style="color:green;">'</span><br>
|
||||
<span style="color:green;">'Form1</span><br>
|
||||
<span style="color:green;">'</span><br>
|
||||
<span style="color:blue;">Me</span>.AutoScaleDimensions = <span style="color:blue;">New</span> System.Drawing.<span style="color:#2b91af;">SizeF</span>(6.0!, 13.0!)<br>
|
||||
<span style="color:blue;">Me</span>.AutoScaleMode = System.Windows.Forms.<span style="color:#2b91af;">AutoScaleMode</span>.Font<br>
|
||||
<span style="color:blue;">Me</span>.ClientSize = <span style="color:blue;">New</span> System.Drawing.<span style="color:#2b91af;">Size</span>(287, 136)<br>
|
||||
<span style="color:blue;">Me</span>.Controls.Add(<span style="color:blue;">Me</span>.Button1)<br>
|
||||
<span style="color:blue;">Me</span>.Controls.Add(<span style="color:blue;">Me</span>.GetLoggedIn)<br>
|
||||
<span style="color:blue;">Me</span>.Name = <span style="color:#a31515;">"Form1"</span><br>
|
||||
<span style="color:blue;">Me</span>.Text = <span style="color:#a31515;">"Create new vault"</span><br>
|
||||
<span style="color:blue;">Me</span>.ResumeLayout(<span style="color:blue;">False</span>)<br>
|
||||
<span style="color:blue;">Me</span>.PerformLayout()<br>
|
||||
<br>
|
||||
<span style="color:blue;">End</span> <span style="color:blue;">Sub</span><br>
|
||||
<br>
|
||||
<span style="color:blue;">#End</span> <span style="color:blue;">Region</span><br>
|
||||
<br>
|
||||
<span style="color:blue;">Friend</span> <span style="color:blue;">WithEvents</span> GetLoggedIn <span style="color:blue;">As</span> System.Windows.Forms.<span style="color:#2b91af;">Button</span><br>
|
||||
<span style="color:blue;">Friend</span> <span style="color:blue;">WithEvents</span> Button1 <span style="color:blue;">As</span> System.Windows.Forms.<span style="color:#2b91af;">Button</span></p>
|
||||
<p style="font-family: Courier New; font-size: 13; color: black; background: white" class="APICODE">
|
||||
<br>
|
||||
<span style="color:blue;">End</span> <span style="color:blue;">Class</span></p>
|
||||
</font>
|
||||
<p align="center"><a href="#top">Back to top</a></p>
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
Reference in New Issue
Block a user