GetGlobalParameter Method

Syntax

Visual Basic
Public Function GetGlobalParameter( _ ByVal Parameter As ApplicationGlobalConstants, _ ByRef Value As Variant _ ) As Long

Parameters

Parameter

Value	Description
seApplicationGlobalAdminFileLocation
seApplicationGlobalApplyStatusToLinks
seApplicationGlobalAvailableRootFolder
seApplicationGlobalBaselinedRootFolder
seApplicationGlobalCheckInOnClose
seApplicationGlobalExcludedCharactersFromRevision
seApplicationGlobalInReviewRootFolder
seApplicationGlobalInsightCacheLocation
seApplicationGlobalInsightFolderMappingFileLocation
seApplicationGlobalInWorkRootFolder
seApplicationGlobalLogFilesLocation
seApplicationGlobalLookAheadVersion
seApplicationGlobalMakeRevisionsObsolete
seApplicationGlobalMaximumCharactersInRevision
seApplicationGlobalObsoleteRootFolder
seApplicationGlobalOfflineMode
seApplicationGlobalReleasedRootFolder
seApplicationGlobalRevisionDelimiter
seApplicationGlobalSearchScope
seApplicationGlobalStartingRevisionValue
seApplicationGlobalTeamcenterFormula
seApplicationGlobalUpdateDraft
seApplicationGlobalUploadOnClose

Specifies the global parameter for which the setting is to be returned.

Value

Returns the setting of the specified global parameter. The data type returned depends on the data being queried. For Application objects, the return data type is Long or Variant. For all other objects, the returned data type is Double.

Example

Example (VB.NET)

Imports RevisionManager
Imports System.Runtime.InteropServices

Module Example

    Sub Main()
        Dim objApplication As RevisionManager.Application = Nothing
        Dim strLocalCacheLocation As String = Nothing

        Try
            ' Start Revision Manager.
            objApplication = New RevisionManager.Application

            objApplication.GetGlobalParameter(ApplicationGlobalConstants.seApplicationGlobalInsightCacheLocation, strLocalCacheLocation)
        Catch ex As Exception
            ' Write any errors to console.
            Console.WriteLine(ex.Message)
        Finally
            ' Release COM Objects.
            If Not (objApplication Is Nothing) Then
                objApplication.Quit()
                Marshal.ReleaseComObject(objApplication)
                objApplication = Nothing
            End If
        End Try
    End Sub

End Module