SoPreferences.GetString Method

SoPreferencesGetString Method

Returns the value of the specified environment variable in the Open Inventor environment.

Namespace: OIV.Inventor
Assembly: OIV.Inventor.Base (in OIV.Inventor.Base.dll) Version: 2024.1.1.0 (2024.1.1)

Syntax

public static string GetString(
	string name,
	string defaultValue
)

Public Shared Function GetString ( 
	name As String,
	defaultValue As String
) As String

public:
static String^ GetString(
	String^ name, 
	String^ defaultValue
)

static member GetString : 
        name : string * 
        defaultValue : string -> string

Parameters

name: Type: SystemString
defaultValue: Type: SystemString

Return Value

Type: String

Remarks

The search process is the same as for OIV.Inventor.SoPreferences.GetValue(System.String). If the environment variable is not defined in the Open Inventor environment, or if it is defined with no values or as an empty string, the specified default value will be returned.

Reference

SoPreferences Class

OIV.Inventor Namespace