SoPreferences.GetFloat Method

SoPreferencesGetFloat Method

Returns the value of the specified environment variable in the Open Inventor environment, interpreted as a float.

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

Syntax

public static float GetFloat(
	string name,
	float defaultValue
)

Public Shared Function GetFloat ( 
	name As String,
	defaultValue As Single
) As Single

public:
static float GetFloat(
	String^ name, 
	float defaultValue
)

static member GetFloat : 
        name : string * 
        defaultValue : float32 -> float32

Parameters

name: Type: SystemString
defaultValue: Type: SystemSingle

Return Value

Type: Single

Remarks

The search process is the same as for getValue. If the environment variable is not defined in the Open Inventor environment, or if its value cannot be interpreted as a float, the specified default value will be returned.

Reference

SoPreferences Class

OIV.Inventor Namespace