Skip to main content

Zemax OpticStudio ZOS-API 2026 R1

Interface ZOSAPI::Editors::LDE::ISurfaceScatteringUser

Last update: 13.03.2026

Definition:

Surface Scattering - User. This interface can be retrieved from the ILDEScatteringData interface.

Inherits from:

Members

Properties

Property DLLName

Definition:

string ZOSAPI.Editors.LDE.ISurfaceScatteringUser.DLLName

Return type: string

Property NumberOfParameters

Definition:

int ZOSAPI.Editors.LDE.ISurfaceScatteringUser.NumberOfParameters

Gets the number of parameters used by the specified dll.

The number of parameters.

Return type: int

Public functions

Function GetAvailableDLLNames

string[] ZOSAPI.Editors.LDE.ISurfaceScatteringUser.GetAvailableDLLNames()

Return type: string[]

Function GetParameterName

string ZOSAPI.Editors.LDE.ISurfaceScatteringUser.GetParameterName(int paramIdx)

Gets the name of the specified parameter.

Parameters:

  • paramIdx: Index of the parameter (0 to NumberOfParameters-1).

Returns:

Parameters:

  • int paramIdx

Return type: string

Function GetParameterValue

double ZOSAPI.Editors.LDE.ISurfaceScatteringUser.GetParameterValue(int paramIdx)

Gets the value of the specified parameter.

Parameters:

  • paramIdx: Index of the parameter (0 to NumberOfParameters-1).

Returns:

Parameters:

  • int paramIdx

Return type: double

Function SetParameterValue

bool ZOSAPI.Editors.LDE.ISurfaceScatteringUser.SetParameterValue(int paramIdx, double Value)

Sets the value of the specified parameter.

Parameters:

  • paramIdx: Index of the parameter (0 to NumberOfParameters-1).
  • Value: The value.

Returns:

Parameters:

  • int paramIdx
  • double Value

Return type: bool

Connect with Ansys