GetGlobalParameter Method

Description

This method gets the value of a specified global parameter for the referenced Application.

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
seApplicationGlobalShowProcessedActions
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)
Example (C#)

Option Infer On

Imports System
Imports System.Runtime.InteropServices

Namespace Examples
    Friend Class Program
        <STAThread>
        Shared Sub Main(ByVal args() As String)
            Dim application As DesignManager.Application = Nothing

            Try
                application = New DesignManager.Application()

                Dim Parameter = DesignManager.ApplicationGlobalConstants.seApplicationGlobalInsightCacheLocation
                Dim Value As Object = Nothing

                application.GetGlobalParameter(Parameter, Value)
            Catch ex As System.Exception
                Console.WriteLine(ex)
            End Try
        End Sub
    End Class
End Namespace

using System;
using System.Runtime.InteropServices;

namespace Examples
{
    class Program
    {
        [STAThread]
        static void Main(string[] args)
        {
            DesignManager.Application application = null;

            try
            {
                application = new DesignManager.Application();

                var Parameter = DesignManager.ApplicationGlobalConstants.seApplicationGlobalInsightCacheLocation;
                object Value = null;

                application.GetGlobalParameter(Parameter, ref Value);
            }
            catch (System.Exception ex)
            {
                Console.WriteLine(ex);
            }
        }
    }
}