Zemax OpticStudio ZOS-API 2026 R1

Interface ZOSAPI::Common::ISettingsData

Last update: 13.03.2026

Definition:

Methods and interfaces for storing and retrieving user-defined settings.
All settings are referenced via a user-defined string key, and has a specific type associated with it (e.g. a single integer, array of doubles, etc.).

Members

Properties

Property NumberOfSettings

Definition:

int ZOSAPI.Common.ISettingsData.NumberOfSettings

Gets the total number of settings currently stored via the API.

The number of settings.

Return type: int

Public functions

Function GetKeys

string[] ZOSAPI.Common.ISettingsData.GetKeys()

Gets an array of all keys currently stored.

Returns:

Return type: string[]

Function GetEntryType

bool ZOSAPI.Common.ISettingsData.GetEntryType(string key, [Out]out SettingsDataType type, [Out]out bool isArray, [Out]out int arraySize)

Gets information about the data associated with the specified key.

Parameters:

  • key: The key.
  • type: The of data associated with the key.
  • isArray: If set to true, the data is stored as an array of SettingsDataType.
  • arraySize: The number of elements of the array, or 1 if it is a single element.

Returns:

true if the key exists; otherwise, false.

Parameters:

  • string key
  • [Out] out SettingsDataType type
  • [Out] out bool isArray
  • [Out] out int arraySize

Return type: bool

Function GetDoubleValue

bool ZOSAPI.Common.ISettingsData.GetDoubleValue(string key, [Out]out double val)

Parameters:

  • string key
  • [Out] out double val

Return type: bool

Function GetIntegerValue

bool ZOSAPI.Common.ISettingsData.GetIntegerValue(string key, [Out]out int val)

Parameters:

  • string key
  • [Out] out int val

Return type: bool

Function GetFloatValue

bool ZOSAPI.Common.ISettingsData.GetFloatValue(string key, [Out]out float val)

Parameters:

  • string key
  • [Out] out float val

Return type: bool

Function GetStringValue

bool ZOSAPI.Common.ISettingsData.GetStringValue(string key, [Out]out string val)

Parameters:

  • string key
  • [Out] out string val

Return type: bool

Function GetByteValue

bool ZOSAPI.Common.ISettingsData.GetByteValue(string key, [Out]out byte val)

Parameters:

  • string key
  • [Out] out byte val

Return type: bool

Function GetBooleanValue

bool ZOSAPI.Common.ISettingsData.GetBooleanValue(string key, [Out]out bool val)

Parameters:

  • string key
  • [Out] out bool val

Return type: bool

Function SetDoubleValue

void ZOSAPI.Common.ISettingsData.SetDoubleValue(string key, [In]double val)

Parameters:

  • string key
  • [In] double val

Return type: void

Function SetIntegerValue

void ZOSAPI.Common.ISettingsData.SetIntegerValue(string key, [In]int val)

Parameters:

  • string key
  • [In] int val

Return type: void

Function SetFloatValue

void ZOSAPI.Common.ISettingsData.SetFloatValue(string key, [In]float val)

Parameters:

  • string key
  • [In] float val

Return type: void

Function SetStringValue

void ZOSAPI.Common.ISettingsData.SetStringValue(string key, [In]string val)

Parameters:

  • string key
  • [In] string val

Return type: void

Function SetByteValue

void ZOSAPI.Common.ISettingsData.SetByteValue(string key, [In]byte val)

Parameters:

  • string key
  • [In] byte val

Return type: void

Function SetBooleanValue

void ZOSAPI.Common.ISettingsData.SetBooleanValue(string key, [In]bool val)

Parameters:

  • string key
  • [In] bool val

Return type: void

Function GetDoubleArray

bool ZOSAPI.Common.ISettingsData.GetDoubleArray(string key, int Size, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=1)][In, Out]double[] val)

Parameters:

  • string key
  • int Size
  • [In, Out] double[] val

Return type: bool

Function GetIntegerArray

bool ZOSAPI.Common.ISettingsData.GetIntegerArray(string key, int Size, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=1)][In, Out]int[] val)

Parameters:

  • string key
  • int Size
  • [In, Out] int[] val

Return type: bool

Function GetFloatArray

bool ZOSAPI.Common.ISettingsData.GetFloatArray(string key, int Size, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=1)][In, Out]float[] val)

Parameters:

  • string key
  • int Size
  • [In, Out] float[] val

Return type: bool

Function GetByteArray

bool ZOSAPI.Common.ISettingsData.GetByteArray(string key, int Size, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=1)][In, Out]byte[] val)

Parameters:

  • string key
  • int Size
  • [In, Out] byte[] val

Return type: bool

Function GetBooleanArray

bool ZOSAPI.Common.ISettingsData.GetBooleanArray(string key, int Size, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=1)][In, Out]bool[] val)

Parameters:

  • string key
  • int Size
  • [In, Out] bool[] val

Return type: bool

Function SetDoubleArray

void ZOSAPI.Common.ISettingsData.SetDoubleArray(string key, int Size, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=1)][In]double[] val)

Parameters:

  • string key
  • int Size
  • [In] double[] val

Return type: void

Function SetIntegerArray

void ZOSAPI.Common.ISettingsData.SetIntegerArray(string key, int Size, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=1)][In]int[] val)

Parameters:

  • string key
  • int Size
  • [In] int[] val

Return type: void

Function SetFloatArray

void ZOSAPI.Common.ISettingsData.SetFloatArray(string key, int Size, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=1)][In]float[] val)

Parameters:

  • string key
  • int Size
  • [In] float[] val

Return type: void

Function SetByteArray

void ZOSAPI.Common.ISettingsData.SetByteArray(string key, int Size, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=1)][In]byte[] val)

Parameters:

  • string key
  • int Size
  • [In] byte[] val

Return type: void

Function SetBooleanArray

void ZOSAPI.Common.ISettingsData.SetBooleanArray(string key, int Size, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=1)][In]bool[] val)

Parameters:

  • string key
  • int Size
  • [In] bool[] val

Return type: void

Connect with Ansys