IsTeamCenterFileCheckedOut Method

Description

Checks Whether File is Checked Out or not

Syntax

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

Parameters

bstrFilename: The local cache file path of the file.

Return Type

This API returns an integer value specifying whether the file is checked out to current user or another user or not checked out to any user.

0 - Not checked out.
1 - Checked out to current user.
2 - Checked out to other user.

Example

Example (Visual Basic)

Option Explicit

Sub Example()
    Dim objApplication As SolidEdgeFramework.Application
    Dim objTCE As SolidEdgeFramework.SolidEdgeTCE
    Dim FileName As String
    Dim iCheckedOut As Integer

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

    FileName = "F:\009431.par"
    iCheckedOut = objTCE.IsTeamCenterFileCheckedOut(FileName)

    If Not objApplication Is Nothing Then
        Call objApplication.Quit
    End If
    
    Set objTCE = Nothing
    Set objApplication = Nothing
End Sub