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

It is a Boolean flag. It has following possible values:

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

vbAllLevel

A Boolean flag which will decide the download level of the file.

TRUE - This is going to download the files for one level.
FALSE- Going to download the files for ALL levels.

dwDownloadOption

This parameter is reserved for internal use. Users should use this parameter as shown in below sample code.

pvarListOfFiles

This parameter is reserved for internal use. Since this is an optional parameter users should not use it.

Example

Example (Visual Basic)

Private Sub Command1_Click()
    On Error Resume Next
    Dim objApplication As SolidEdgeFramework.Application
    Dim objSolidEdgeInsightXT  As SolidEdgeFramework.SolidEdgeInsightXT
    
    Set objApplication = GetObject(, "SolidEdge.Application")
    Set objSolidEdgeInsightXT = objApplication.SolidEdgeInsightXT

    Dim FileItemID As String
    Dim FileItemRevID As String
    Dim FileDataSetName As String
    Dim FileRevisionRule As String
    Dim FileVariantRule As String
    Dim vbreadonly As Boolean
    Dim vballlevel As Boolean
    Dim dwDownloadOption As Integer
    
    FileItemID = "020147"
    FileItemRevID = "A"
    FileDataSetName = "020147.par"
    FileRevisionRule = "latest working"
    FileVariantRule = ""
    vbreadonly = True
    vballlevel = False
    
    Call objSolidEdgeInsightXT.DownladDocumentsFromServerWithOptions(FileItemID, _
        FileItemRevID, _
        FileDataSetName, _
        FileRevisionRule, _
        FileVariantRule, _
        vbreadonly, _
        vballlevel, _
        dwDownloadOption)

    Set objSolidEdgeInsightXT = Nothing
    Set objApplication = Nothing
End Sub