DownladDocumentsFromServerWithOptions Method

Description

Checkout document from the server with options given by the user.

Syntax

Visual Basic
Public Sub DownladDocumentsFromServerWithOptions( _ ByVal bstrItemId As String, _ ByVal bstrItemRev As String, _ ByVal bstrDataSetFileName As String, _ ByVal bstrRevisionRule As String, _ ByVal bstrVariantRule As String, _ ByVal vbReadOnly As Boolean, _ ByVal vbAllLevel As Boolean, _ ByVal dwDownloadOption As ULong, _ Optional ByRef pvarListOfFiles() As Variant _ )

Visual Basic

Public Sub DownladDocumentsFromServerWithOptions( _
   ByVal bstrItemId As String, _
   ByVal bstrItemRev As String, _
   ByVal bstrDataSetFileName As String, _
   ByVal bstrRevisionRule As String, _
   ByVal bstrVariantRule As String, _
   ByVal vbReadOnly As Boolean, _
   ByVal vbAllLevel As Boolean, _
   ByVal dwDownloadOption As ULong, _
   Optional ByRef pvarListOfFiles() As Variant _
)

Parameters

bstrItemId: Specifies the Item Id of the file which user wants to download.
bstrItemRev: Specifies the Revision of the file to be downloaded.
bstrDataSetFileName: Specifies the Data set name of the file which is to be downloaded.
bstrRevisionRule: Revision rule of the file.
bstrVariantRule: Variant rule of the file.
vbReadOnly: 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.
vbAllLevel: TRUE - This is going to download the files for one level. FALSE- Going to download the files for ALL levels.
dwDownloadOption: A value from the TCDownloadOptions.
pvarListOfFiles: Requires 2 dimensional array. This argument is not optional.

Example

Example (Visual Basic)

Module Module1
    Sub Main()
        Dim objApp As SolidEdgeFramework.Application
        Dim objSEEC As SolidEdgeFramework.SolidEdgeTCE

        Dim varInputList(1) As Object
        Dim FileItemID As String
        Dim FileItemRevID As String
        Dim FileDataSetName As String
        Dim FileRevisionRule As String
        Dim FolderName As String
        Dim temp(0, 0) As Object

        FileItemID = "020670"
        FileItemRevID = "A"
        FileDataSetName = "020670.par"
        FileRevisionRule = ""
        FolderName = ""

        objApp = GetObject(, "SolidEdge.Application")
        objSEEC = objApp.SolidEdgeTCE

        'temp is a 2 dimensional array which is not optional
        objSEEC.DownladDocumentsFromServerWithOptions(FileItemID, FileItemRevID, FileDataSetName, _
        SolidEdgeConstants.RevisionRuleType.LatestRevision, "", False, True, SolidEdgeConstants.TCDownloadOptions.COImplicit, temp)
    End Sub
End Module