Batch Checkin/Checkout Using menu command -API

Hi,

I tried to do Batch checkin/Checkout. But its not processing all the files I selected. Its just process only that selected(where I right click). Am I doing anything wrong?

  Case EdmCmdType.EdmCmd_Menu<br><br>                If poCmd.mlCmdID = 1000 Then<br><br>                    poCmd.mlEdmRefreshFlags = 1<br>                    Dim edmVault As IEdmVault7 = TryCast(poCmd.mpoVault, IEdmVault7)<br>                    Dim edmBatchUnlock As IEdmBatchUnlock<br>                    edmBatchUnlock = edmVault.CreateUtility(EdmUtility.EdmUtil_BatchUnlock)<br>                    Dim i As Integer = 0<br>                    Dim selectedItems(i) As EdmSelItem<br><br>                    For Each AffectedFile As EdmCmdData In ppoData<br><br>                        Dim oFile As IEdmFile5 = edmVault.GetObject(EdmObjectType.EdmObject_File, AffectedFile.mlObjectID1)<br>                        selectedItems(i).mlDocID = AffectedFile.mlObjectID1<br>                        selectedItems(i).mlProjID = AffectedFile.mlObjectID3<br>                        MessageBox.Show(oFile.GetLocalPath(AffectedFile.mlObjectID3).ToString)<br>                        i = i + 1<br><br>                    Next<br><br>                    Try<br>                        edmBatchUnlock.AddSelection(edmVault, selectedItems)<br>                        edmBatchUnlock.CreateTree(0, 1)<br>                        edmBatchUnlock.UnlockFiles(0)<br>                    Catch ex As Exception<br>                        MessageBox.Show(ex.Message.ToString)<br>                    End Try<br><br>                End If<br>        End Select<span class="line-numbers-rows"><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span></span>

Thanks

SolidworksApi/macros
Answers 4
MD
MD 2021-03-26 Best Answer

On line 10 it appears that you have declared selectedItems as an Array of one item.

AJ
AJ 2021-03-26
<span class="comment token">/// <summary></span><br><span class="comment token">/// Batch check out an array of PDM files.</span><br><span class="comment token">/// </summary></span><br><span class="comment token">/// <param name="Vault">Vault object.</param></span><br><span class="comment token">/// <param name="files">array of filenames.</param></span><br><span class="comment token">/// <param name="Handle">Handle of the parent window.</param></span><br><span class="comment token">/// <returns>MethodReturn of boolean: True if successful, false if not.</returns></span><br><span class="comment token">/// <remarks>Method is not thread-safe. Use this method only in the main thread of your application.</remarks></span><br><span class="keyword token">public</span> <span class="keyword token">static</span> <span class="keyword token">bool</span> <span class="token function">BatchCheckOutFiles</span><span class="punctuation token">(</span><span class="keyword token">this</span> IEdmVault5 Vault<span class="punctuation token">,</span> <span class="keyword token">string</span><span class="punctuation token">[</span><span class="punctuation token">]</span> files<span class="punctuation token">,</span> <span class="keyword token">int</span> Handle<span class="punctuation token">)</span><br><span class="punctuation token">{</span><br><span class="comment token">// create batch locker object </span><br><span class="keyword token">var</span> batchLocker <span class="operator token">=</span> <span class="punctuation token">(</span>IEdmBatchGet<span class="punctuation token">)</span><span class="punctuation token">(</span>Vault <span class="keyword token">as</span> IEdmVault8<span class="punctuation token">)</span><span class="punctuation token">.</span><span class="token function">CreateUtility</span><span class="punctuation token">(</span>EdmUtility<span class="punctuation token">.</span>EdmUtil_BatchGet<span class="punctuation token">)</span> <span class="keyword token">as</span> IEdmBatchGet<span class="punctuation token">;</span><br><span class="comment token">// create the selection list </span><br><span class="keyword token">var</span> list <span class="operator token">=</span> <span class="keyword token">new</span> <span class="token class-name">List</span><span class="operator token"><</span>EdmSelItem<span class="operator token">></span><span class="punctuation token">(</span><span class="punctuation token">)</span><span class="punctuation token">;</span><br><span class="keyword token">var</span> selectedFile <span class="operator token">=</span> <span class="keyword token">default</span><span class="punctuation token">(</span>EdmSelItem<span class="punctuation token">)</span><span class="punctuation token">;</span><br><span class="keyword token">foreach</span> <span class="punctuation token">(</span><span class="keyword token">var</span> file <span class="keyword token">in</span> files<span class="punctuation token">)</span><br><span class="punctuation token">{</span><br><span class="keyword token">var</span> ppoRetParentFolder <span class="operator token">=</span> <span class="keyword token">default</span><span class="punctuation token">(</span>IEdmFolder5<span class="punctuation token">)</span><span class="punctuation token">;</span><br><span class="keyword token">var</span> aFile <span class="operator token">=</span> Vault<span class="punctuation token">.</span><span class="token function">GetFileFromPath</span><span class="punctuation token">(</span>file<span class="punctuation token">,</span> <span class="keyword token">out</span> ppoRetParentFolder<span class="punctuation token">)</span><span class="punctuation token">;</span><br> selectedFile <span class="operator token">=</span> <span class="keyword token">new</span> <span class="token class-name">EdmSelItem</span><span class="punctuation token">(</span><span class="punctuation token">)</span><span class="punctuation token">;</span><br> IEdmPos5 aPos <span class="operator token">=</span> aFile<span class="punctuation token">.</span><span class="token function">GetFirstFolderPosition</span><span class="punctuation token">(</span><span class="punctuation token">)</span><span class="punctuation token">;</span><br> IEdmFolder5 aFolder <span class="operator token">=</span> aFile<span class="punctuation token">.</span><span class="token function">GetNextFolder</span><span class="punctuation token">(</span>aPos<span class="punctuation token">)</span><span class="punctuation token">;</span><br> selectedFile<span class="punctuation token">.</span>mlDocID <span class="operator token">=</span> aFile<span class="punctuation token">.</span>ID<span class="punctuation token">;</span><br> selectedFile<span class="punctuation token">.</span>mlProjID <span class="operator token">=</span> aFolder<span class="punctuation token">.</span>ID<span class="punctuation token">;</span><br> list<span class="punctuation token">.</span><span class="token function">Add</span><span class="punctuation token">(</span>selectedFile<span class="punctuation token">)</span><span class="punctuation token">;</span><br><span class="punctuation token">}</span><br><span class="keyword token">var</span> vault1 <span class="operator token">=</span> <span class="keyword token">new</span> <span class="token class-name">EdmVault5</span><span class="punctuation token">(</span><span class="punctuation token">)</span><span class="punctuation token">;</span><br> vault1 <span class="operator token">=</span> <span class="punctuation token">(</span>EdmVault5<span class="punctuation token">)</span>Vault<span class="punctuation token">;</span><br><span class="comment token">// do not change this - the array must init as null</span><br> EdmSelItem<span class="punctuation token">[</span><span class="punctuation token">]</span> ppoSelection <span class="operator token">=</span> <span class="keyword token">null</span><span class="punctuation token">;</span><br>ppoSelection <span class="operator token">=</span> list<span class="punctuation token">.</span><span class="token function">ToArray</span><span class="punctuation token">(</span><span class="punctuation token">)</span><span class="punctuation token">;</span><br> batchLocker<span class="punctuation token">.</span><span class="token function">AddSelection</span><span class="punctuation token">(</span>vault1<span class="punctuation token">,</span> <span class="keyword token">ref</span> ppoSelection<span class="punctuation token">)</span><span class="punctuation token">;</span><br><span class="comment token">//create tree </span><br> batchLocker<span class="punctuation token">.</span><span class="token function">CreateTree</span><span class="punctuation token">(</span>Handle<span class="punctuation token">,</span> <span class="punctuation token">(</span><span class="keyword token">int</span><span class="punctuation token">)</span>EdmGetCmdFlags<span class="punctuation token">.</span>Egcf_Lock<span class="punctuation token">)</span><span class="punctuation token">;</span><br><span class="comment token">// lock file </span><br> batchLocker<span class="punctuation token">.</span><span class="token function">GetFiles</span><span class="punctuation token">(</span>Handle<span class="punctuation token">,</span> <span class="keyword token">null</span><span class="punctuation token">)</span><span class="punctuation token">;</span><br><span class="keyword token">return</span> <span class="keyword token">true</span><span class="punctuation token">;</span><br><span class="punctuation token">}</span><span class="line-numbers-rows"><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span></span>


Best,
Amen
SOLIDWORKS PDM API Programming services

AJ
AJ 2021-03-26
<span class="comment token">/// <summary></span><br><span class="comment token">/// Batch check-in files.</span><br><span class="comment token">/// </summary></span><br><span class="comment token">/// <param name="Vault">Vault object.</param></span><br><span class="comment token">/// <param name="files">array of filenames.</param></span><br><span class="comment token">/// <param name="Handle">Handle of the parent window.</param></span><br><span class="comment token">/// <returns>Tuple of boolean: True if successful, false if not. Item2 is the exception's message</returns></span><br><span class="comment token">/// <remarks>Method is not thread-safe. Use this method only in the main thread of your application.</remarks></span><br><span class="keyword token">public</span> <span class="keyword token">static</span> Tuple<span class="operator token"><</span><span class="keyword token">bool</span><span class="punctuation token">,</span><span class="keyword token">string</span><span class="operator token">></span> <span class="token function">BatchCheckIn</span><span class="punctuation token">(</span><span class="keyword token">this</span> IEdmVault5 Vault<span class="punctuation token">,</span> <span class="keyword token">string</span><span class="punctuation token">[</span><span class="punctuation token">]</span> files<span class="punctuation token">,</span> <span class="keyword token">int</span> Handle<span class="punctuation token">)</span><br><span class="punctuation token">{</span><br><span class="keyword token">try</span> <br><span class="punctuation token">{</span> <br><span class="comment token">// create batch unlocker object </span><br><span class="keyword token">var</span> batchUnlocker <span class="operator token">=</span> <span class="punctuation token">(</span>IEdmBatchUnlock2<span class="punctuation token">)</span><span class="punctuation token">(</span>Vault <span class="keyword token">as</span> IEdmVault8<span class="punctuation token">)</span><span class="punctuation token">.</span><span class="token function">CreateUtility</span><span class="punctuation token">(</span>EdmUtility<span class="punctuation token">.</span>EdmUtil_BatchUnlock<span class="punctuation token">)</span> <span class="keyword token">as</span> IEdmBatchUnlock2<span class="punctuation token">;</span><br><span class="comment token">// create the selection list </span><br><span class="keyword token">var</span> list <span class="operator token">=</span> <span class="keyword token">new</span> <span class="token class-name">List</span><span class="operator token"><</span>EdmSelItem<span class="operator token">></span><span class="punctuation token">(</span><span class="punctuation token">)</span><span class="punctuation token">;</span><br><span class="keyword token">var</span> selectedFile <span class="operator token">=</span> <span class="keyword token">default</span><span class="punctuation token">(</span>EdmSelItem<span class="punctuation token">)</span><span class="punctuation token">;</span><br><span class="keyword token">foreach</span> <span class="punctuation token">(</span><span class="keyword token">var</span> file <span class="keyword token">in</span> files<span class="punctuation token">)</span><br><span class="punctuation token">{</span><br><span class="keyword token">var</span> ppoRetParentFolder <span class="operator token">=</span> <span class="keyword token">default</span><span class="punctuation token">(</span>IEdmFolder5<span class="punctuation token">)</span><span class="punctuation token">;</span><br><span class="keyword token">var</span> aFile <span class="operator token">=</span> Vault<span class="punctuation token">.</span><span class="token function">GetFileFromPath</span><span class="punctuation token">(</span>file<span class="punctuation token">,</span> <span class="keyword token">out</span> ppoRetParentFolder<span class="punctuation token">)</span><span class="punctuation token">;</span><br> selectedFile <span class="operator token">=</span> <span class="keyword token">new</span> <span class="token class-name">EdmSelItem</span><span class="punctuation token">(</span><span class="punctuation token">)</span><span class="punctuation token">;</span><br> IEdmPos5 aPos <span class="operator token">=</span> aFile<span class="punctuation token">.</span><span class="token function">GetFirstFolderPosition</span><span class="punctuation token">(</span><span class="punctuation token">)</span><span class="punctuation token">;</span><br> IEdmFolder5 aFolder <span class="operator token">=</span> aFile<span class="punctuation token">.</span><span class="token function">GetNextFolder</span><span class="punctuation token">(</span>aPos<span class="punctuation token">)</span><span class="punctuation token">;</span><br> selectedFile<span class="punctuation token">.</span>mlDocID <span class="operator token">=</span> aFile<span class="punctuation token">.</span>ID<span class="punctuation token">;</span><br> selectedFile<span class="punctuation token">.</span>mlProjID <span class="operator token">=</span> aFolder<span class="punctuation token">.</span>ID<span class="punctuation token">;</span><br> list<span class="punctuation token">.</span><span class="token function">Add</span><span class="punctuation token">(</span>selectedFile<span class="punctuation token">)</span><span class="punctuation token">;</span><br><span class="punctuation token">}</span><br><span class="keyword token">var</span> vault1 <span class="operator token">=</span> <span class="keyword token">new</span> <span class="token class-name">EdmVault5</span><span class="punctuation token">(</span><span class="punctuation token">)</span><span class="punctuation token">;</span><br> vault1 <span class="operator token">=</span> <span class="punctuation token">(</span>EdmVault5<span class="punctuation token">)</span>Vault<span class="punctuation token">;</span><br><span class="comment token">// do not change this - the array must init as null</span><br> EdmSelItem<span class="punctuation token">[</span><span class="punctuation token">]</span> ppoSelection <span class="operator token">=</span> <span class="keyword token">null</span><span class="punctuation token">;</span><br>ppoSelection <span class="operator token">=</span> list<span class="punctuation token">.</span><span class="token function">ToArray</span><span class="punctuation token">(</span><span class="punctuation token">)</span><span class="punctuation token">;</span><br> batchUnlocker<span class="punctuation token">.</span><span class="token function">AddSelection</span><span class="punctuation token">(</span>vault1<span class="punctuation token">,</span> <span class="keyword token">ref</span> ppoSelection<span class="punctuation token">)</span><span class="punctuation token">;</span><br><span class="comment token">//create tree </span><br> batchUnlocker<span class="punctuation token">.</span><span class="token function">CreateTree</span><span class="punctuation token">(</span>Handle<span class="punctuation token">,</span> <span class="punctuation token">(</span><span class="keyword token">int</span><span class="punctuation token">)</span>EdmUnlockBuildTreeFlags<span class="punctuation token">.</span>Eubtf_ShowCloseAfterCheckinOption <span class="operator token">+</span> <span class="punctuation token">(</span><span class="keyword token">int</span><span class="punctuation token">)</span>EdmUnlockBuildTreeFlags<span class="punctuation token">.</span>Eubtf_MayUnlock<span class="punctuation token">)</span><span class="punctuation token">;</span><br><span class="comment token">// unlock file </span><br> batchUnlocker<span class="punctuation token">.</span><span class="token function">UnlockFiles</span><span class="punctuation token">(</span>Handle<span class="punctuation token">,</span> <span class="keyword token">null</span><span class="punctuation token">)</span><span class="punctuation token">;</span><br><span class="keyword token">return</span> <span class="keyword token">new</span> <span class="token class-name">Tuple</span><span class="operator token"><</span><span class="keyword token">bool</span><span class="punctuation token">,</span> <span class="keyword token">string</span><span class="operator token">></span><span class="punctuation token">(</span><span class="keyword token">true</span><span class="punctuation token">,</span> <span class="keyword token">string</span><span class="punctuation token">.</span>Empty<span class="punctuation token">)</span><span class="punctuation token">;</span><br><span class="punctuation token">}</span><br><span class="keyword token">catch</span> <span class="punctuation token">(</span><span class="token class-name">COMException</span> e<span class="punctuation token">)</span><br><span class="punctuation token">{</span><br><span class="keyword token">return</span> <span class="keyword token">new</span> <span class="token class-name">Tuple</span><span class="operator token"><</span><span class="keyword token">bool</span><span class="punctuation token">,</span> <span class="keyword token">string</span><span class="operator token">></span><span class="punctuation token">(</span><span class="keyword token">false</span><span class="punctuation token">,</span> e<span class="punctuation token">.</span>Message<span class="punctuation token">)</span><span class="punctuation token">;</span><br><span class="punctuation token">}</span><br><span class="punctuation token">}</span><br><span class="line-numbers-rows"><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span><span>‍</span></span>


Best,
Amen
SOLIDWORKS PDM API Programming services

WM
WM 2021-03-26

To add to what Mike is saying, you have that array of only one selected file and then you are using are adding that one selected file to the batch unlock utility.

edmBatchUnlock.AddSelection(edmVault, selectedItems)

The API help file example passes an array of EDMSelItem.

http://help.solidworks.com/2018/English/api/epdmapi/Batch_Unlock_Files_Example_VBNET.htm