CheckOutDocumentsFromTeamCenterServer Method

Description

Checkout the File from the server

Syntax

Visual Basic
Public Sub CheckOutDocumentsFromTeamCenterServer( _ ByVal bstrDirctFileItemId As String, _ ByVal bstrDirctFileItemRevId As String, _ ByVal bOnlyDownload As Boolean, _ Optional ByVal bstrFilename As String, _ Optional ByVal enumDownloadLevel As DocumentDownloadLevel = SEECDownloadAllLevel _ )

Visual Basic

Public Sub CheckOutDocumentsFromTeamCenterServer( _
   ByVal bstrDirctFileItemId As String, _
   ByVal bstrDirctFileItemRevId As String, _
   ByVal bOnlyDownload As Boolean, _
   Optional ByVal bstrFilename As String, _
   Optional ByVal enumDownloadLevel As DocumentDownloadLevel = SEECDownloadAllLevel _
)

Parameters

bstrDirctFileItemId

Specifies the item-id of the item.

bstrDirctFileItemRevId

Specifies the item-rev of the item.

bOnlyDownload

TRUE – In case where it is required to only download the given item from the Teamcenter database but don’t want to check it out. FALSE – In case where it is required to both download as well as checkout.

bstrFilename

enumDownloadLevel

Value	Description
SEECDownloadAllLevel
SEECDownloadFirstLevel
SEECDownloadTopLevel

Example

Example (Visual Basic)

Private Sub Command1_Click()
    On Error Resume Next
    Dim objApplication As SolidEdgeFramework.Application
    Dim objSolidEdgeTCE As SolidEdgeFramework.SolidEdgeTCE

    Set objApplication = GetObject(, "SolidEdge.Application")
    Set objSolidEdgeTCE = objApplication.SolidEdgeTCE

    Dim FileItemID As String
    Dim FileItemRevID As String
    Dim bOnlydownload As Boolean
                            
    FileItemID = "009431"
    FileItemRevID = "A"
    bOnlydownload = True
                                        
    Call objSolidEdgeTCE.CheckOutDocumentsFromTeamCenterServer(FileItemID, FileItemRevID, bOnlydownload)
   
    'Reset the object definition
    Set objSolidEdgeTCE = Nothing
    Set objApplication = Nothing
End Sub