IsInsightXTFileCheckedOut Method

Description

Checks Whether File is Checked Out or not

Syntax

Visual Basic
Public Function IsInsightXTFileCheckedOut( _ ByVal bstrFilename As String _ ) As Integer

Parameters

bstrFilename: The local cache file path of the file.

Return Type

Returns an integer value ‘iCheckedOut’ specifying whether the file is checked out to current user or another user or not checked out to any user.

The value of the element ‘iCheckedOut’ can be as follows:

0 – Not Checked out to any body.
1 – Checked out to me (i.e. current User)
2 – Checked out to other user.

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 FileName As String
    Dim iCheckedOut As Integer

    FileName = "F:\009431.par"

    iCheckedOut = objSolidEdgeInsightXT.IsInsightXTFileCheckedOut(FileName)
    MsgBox (iCheckedOut)

    Set objSolidEdgeInsightXT = Nothing
    Set objApplication = Nothing
End Sub