## On this page

  

 

 # ZOSAPI Namespace Reference

 Last update: 17.07.2025 

The [ZOSAPI](namespace_z_o_s_a_p_i.xhtml "The ZOSAPI namespace contains classes for initially connecting to zemax. See also ZOSAPI_Connection,...") namespace contains classes for initially connecting to zemax. See also [ZOSAPI\_Connection](class_z_o_s_a_p_i_1_1_z_o_s_a_p_i___connection.xhtml), and [IZOSAPI\_Application](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml "This interface contains all information about the current ZOS-API connection, as well as methods for ...") for more information. [More...](namespace_z_o_s_a_p_i.xhtml#details)

## <a id="namespaces" name="namespaces"></a>Namespaces

namespace [Analysis](namespace_z_o_s_a_p_i_1_1_analysis.xhtml) namespace [Common](namespace_z_o_s_a_p_i_1_1_common.xhtml) namespace [Editors](namespace_z_o_s_a_p_i_1_1_editors.xhtml) namespace [Preferences](namespace_z_o_s_a_p_i_1_1_preferences.xhtml) namespace [SystemData](namespace_z_o_s_a_p_i_1_1_system_data.xhtml) namespace [Tools](namespace_z_o_s_a_p_i_1_1_tools.xhtml) namespace [Wizards](namespace_z_o_s_a_p_i_1_1_wizards.xhtml) ## <a id="nested-classes" name="nested-classes"></a>Classes

class [APINetCallback](class_z_o_s_a_p_i_1_1_a_p_i_net_callback.xhtml) interface [IOpticalSystem](interface_z_o_s_a_p_i_1_1_i_optical_system.xhtml) Represent a complete optical system. A IOpticalSystem corresponds to a single .ZMX file. See IZOSAPI\_Application for information on how to get or create a IOpticalSystem. [More...](interface_z_o_s_a_p_i_1_1_i_optical_system.xhtml#details)  
 interface [IPreferences](interface_z_o_s_a_p_i_1_1_i_preferences.xhtml) interface [ISTARMaterials](interface_z_o_s_a_p_i_1_1_i_s_t_a_r_materials.xhtml) Top-level access to material properties for STAR module. [More...](interface_z_o_s_a_p_i_1_1_i_s_t_a_r_materials.xhtml#details)  
 interface [ISTARSubsystem](interface_z_o_s_a_p_i_1_1_i_s_t_a_r_subsystem.xhtml) Controls the STAR module at the optical system level. [More...](interface_z_o_s_a_p_i_1_1_i_s_t_a_r_subsystem.xhtml#details)  
 interface [IZAPI\_BaseObject](interface_z_o_s_a_p_i_1_1_i_z_a_p_i___base_object.xhtml) interface [IZOSAPI\_Application](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml) This interface contains all information about the current ZOS-API connection, as well as methods for accessing an Optical System. This interface can only be retrieved from a connection interface - [ZOSAPI.IZOSAPI\_Connection](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___connection.xhtml "This is the initial interface to Optic Studio. All applications that wish to use the ZOS-API must fir...") for more information. [More...](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml#details)  
 interface [IZOSAPI\_Callback](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___callback.xhtml) interface [IZOSAPI\_Connection](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___connection.xhtml) This is the initial interface to Optic Studio. All applications that wish to use the ZOS-API must first establish a connection, using the T:ZOSAPI.ZOSAPI\_Connection class. [More...](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___connection.xhtml#details)  
 interface [IZOSAPI\_Events](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___events.xhtml) COM classes can inherit from this interface if they wish to receive status changed notifications. See also ZOSAPI\_Connection.SystemStatusChangedEvent. [More...](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___events.xhtml#details)  
 class [ZOSAPI\_Connection](class_z_o_s_a_p_i_1_1_z_o_s_a_p_i___connection.xhtml) ## <a id="enum-members" name="enum-members"></a>Enumerations

enum [SystemType](namespace_z_o_s_a_p_i.xhtml#a3c37540f7b61a272f4eb50e826d27daf) { [Sequential](namespace_z_o_s_a_p_i.xhtml#a3c37540f7b61a272f4eb50e826d27dafaa7e82daa7280af25afbaa076ac16eb1e), [NonSequential](namespace_z_o_s_a_p_i.xhtml#a3c37540f7b61a272f4eb50e826d27dafa12d3de3f72d530905c690c2750951117) } enum [LicenseStatusType](namespace_z_o_s_a_p_i.xhtml#a7c677ca4eca8285cae8730422280493e) {   
 [Unknown](namespace_z_o_s_a_p_i.xhtml#a7c677ca4eca8285cae8730422280493ea88183b946cc5f0e8c96b2e66e1c74a7e) = 0 , [KeyNotWorking](namespace_z_o_s_a_p_i.xhtml#a7c677ca4eca8285cae8730422280493eae30c3d85ccc285b6c4cf428f13fc1bb2), [NewLicenseNeeded](namespace_z_o_s_a_p_i.xhtml#a7c677ca4eca8285cae8730422280493ea63f7c30d809599bf49ef8d5d518f3ab8), [StandardEdition](namespace_z_o_s_a_p_i.xhtml#a7c677ca4eca8285cae8730422280493ea80bcaf4301377c8b5dcd277ca28a7bb4),   
 [ProfessionalEdition](namespace_z_o_s_a_p_i.xhtml#a7c677ca4eca8285cae8730422280493ea2ed95be70a6ab6372a8dda3ebfd214d5), [PremiumEdition](namespace_z_o_s_a_p_i.xhtml#a7c677ca4eca8285cae8730422280493ead7c251f26e809b1c6294fa8c0a69b4f5), [TooManyInstances](namespace_z_o_s_a_p_i.xhtml#a7c677ca4eca8285cae8730422280493eaa5ea7465492a8c5d19fbc46e789044b5), [NotAuthorized](namespace_z_o_s_a_p_i.xhtml#a7c677ca4eca8285cae8730422280493ea418ec6476e1acd92e17681f4bd00e3a3),   
 [KeyNotFound](namespace_z_o_s_a_p_i.xhtml#a7c677ca4eca8285cae8730422280493eaa645e4cfc8d16be330607ad52aec5f98), [KeyExpired](namespace_z_o_s_a_p_i.xhtml#a7c677ca4eca8285cae8730422280493ea3995421f2329ce6d6ba6b4ffad1e58ce), [Timeout](namespace_z_o_s_a_p_i.xhtml#a7c677ca4eca8285cae8730422280493eac85a251cc457840f1e032f1b733e9398), [InstanceConflict](namespace_z_o_s_a_p_i.xhtml#a7c677ca4eca8285cae8730422280493ea97ab5524427a661ccb9cd7bb133dd4ff),   
 [OpticsViewer](namespace_z_o_s_a_p_i.xhtml#a7c677ca4eca8285cae8730422280493ea0a55f5a93264f08c562bd0e8fa0f0e02), [OpticStudioHPCEdition](namespace_z_o_s_a_p_i.xhtml#a7c677ca4eca8285cae8730422280493ea095d0bde25fd250873df0bc05d84dd02), [EnterpriseEdition](namespace_z_o_s_a_p_i.xhtml#a7c677ca4eca8285cae8730422280493ea5fb4297717b3cc0d12b46f3f59fe9ecd), [StudentEdition](namespace_z_o_s_a_p_i.xhtml#a7c677ca4eca8285cae8730422280493ea732e0ba6a7d77f2f69b03fe6a52edc6d)  
 } enum [UpdateStatus](namespace_z_o_s_a_p_i.xhtml#ae1500a9901bf1c5a361d63d4fac19d9a) {   
 [CheckFailed](namespace_z_o_s_a_p_i.xhtml#ae1500a9901bf1c5a361d63d4fac19d9aa67964924cf2737ff8335b0fed52d430f) = -2 , [NotSupported](namespace_z_o_s_a_p_i.xhtml#ae1500a9901bf1c5a361d63d4fac19d9aa9ed2d871602556951e39f3cebd08d6cb) = -1 , [NotChecked](namespace_z_o_s_a_p_i.xhtml#ae1500a9901bf1c5a361d63d4fac19d9aac9c0fcb2bb86adc799c4b7eb02412379) = 0 , [UpToDate](namespace_z_o_s_a_p_i.xhtml#ae1500a9901bf1c5a361d63d4fac19d9aa761266b390b3dc960c74d9194512850a) = 1 ,   
 [AvailableEligible](namespace_z_o_s_a_p_i.xhtml#ae1500a9901bf1c5a361d63d4fac19d9aad7c00931b9215da584bea3cc46e9d52e) = 2 , [AvailableIneligible](namespace_z_o_s_a_p_i.xhtml#ae1500a9901bf1c5a361d63d4fac19d9aabf78d5d426412bd40a10e886e14da89c) = 3   
 } enum [ZOSAPI\_Mode](namespace_z_o_s_a_p_i.xhtml#a254f5f6cb4ff37c2245b456b9bb79d2a) {   
 [Server](namespace_z_o_s_a_p_i.xhtml#a254f5f6cb4ff37c2245b456b9bb79d2aa9aa1b03934893d7134a660af4204f2a9), [Operand](namespace_z_o_s_a_p_i.xhtml#a254f5f6cb4ff37c2245b456b9bb79d2aa1b488933c47964ca059d24f978f094e4), [Plugin](namespace_z_o_s_a_p_i.xhtml#a254f5f6cb4ff37c2245b456b9bb79d2aa409c1892b68cb394799262ac57f6d4f1), [UserAnalysis](namespace_z_o_s_a_p_i.xhtml#a254f5f6cb4ff37c2245b456b9bb79d2aa64eebbd15ce06c7625d3e50c3d7b2cbd),   
 [UserAnalysisSettings](namespace_z_o_s_a_p_i.xhtml#a254f5f6cb4ff37c2245b456b9bb79d2aab71755803158960255ee23dc613d4ac2)  
 } enum [LensUpdateMode](namespace_z_o_s_a_p_i.xhtml#a928284b47bbcad0717a234689558250a) { [None](namespace_z_o_s_a_p_i.xhtml#a928284b47bbcad0717a234689558250aa6adf97f83acf6453d4a6a4b1070f3754) = 0 , [EditorsOnly](namespace_z_o_s_a_p_i.xhtml#a928284b47bbcad0717a234689558250aa52a1d4089c743f81411a51a99d90a2e1) = 1 , [AllWindows](namespace_z_o_s_a_p_i.xhtml#a928284b47bbcad0717a234689558250aa59ffd36b33cc5de3325845c3353ec433) = 2 } enum [SessionModes](namespace_z_o_s_a_p_i.xhtml#a0bbab31714d9ab6077ce3a689a286f42) { [FromPreferences](namespace_z_o_s_a_p_i.xhtml#a0bbab31714d9ab6077ce3a689a286f42a8e0a81536e3612d31a704c3ece62a68f) = 0 , [SessionOn](namespace_z_o_s_a_p_i.xhtml#a0bbab31714d9ab6077ce3a689a286f42a1f6ef1cc58fdff6cdfd7c8f5dda169ad) = 1 , [SessionOff](namespace_z_o_s_a_p_i.xhtml#a0bbab31714d9ab6077ce3a689a286f42a5735ac012ce18416658c0d7462c32be8) = 2 } enum [STARUpdateMode](namespace_z_o_s_a_p_i.xhtml#a55b9060ae2fffe30bd5c6cb28e8cd164) { [Normal](namespace_z_o_s_a_p_i.xhtml#a55b9060ae2fffe30bd5c6cb28e8cd164a960b44c579bc2f6818d2daaf9e4c16f0), [Suspended](namespace_z_o_s_a_p_i.xhtml#a55b9060ae2fffe30bd5c6cb28e8cd164a8bf906833cc7aea8084f552217ed9c1d) } ## <a id="func-members" name="func-members"></a>Functions

delegate void [OpticalSystemStatusChangedHandler](namespace_z_o_s_a_p_i.xhtml#afaf981c5f923ffd5800be6562f3ebc0a) (int systemId, string newStatus) <a id="details" name="details"></a>## Detailed Description

The [ZOSAPI](namespace_z_o_s_a_p_i.xhtml "The ZOSAPI namespace contains classes for initially connecting to zemax. See also ZOSAPI_Connection,...") namespace contains classes for initially connecting to zemax. See also [ZOSAPI\_Connection](class_z_o_s_a_p_i_1_1_z_o_s_a_p_i___connection.xhtml), and [IZOSAPI\_Application](interface_z_o_s_a_p_i_1_1_i_z_o_s_a_p_i___application.xhtml "This interface contains all information about the current ZOS-API connection, as well as methods for ...") for more information.



## Enumeration Type Documentation

<a id="a928284b47bbcad0717a234689558250a" name="a928284b47bbcad0717a234689558250a"></a>## [◆ ](#a928284b47bbcad0717a234689558250a)LensUpdateMode

 enum [ZOSAPI.LensUpdateMode](namespace_z_o_s_a_p_i.xhtml#a928284b47bbcad0717a234689558250a)

Enumerator<a id="a928284b47bbcad0717a234689558250aa6adf97f83acf6453d4a6a4b1070f3754" name="a928284b47bbcad0717a234689558250aa6adf97f83acf6453d4a6a4b1070f3754"></a>None <a id="a928284b47bbcad0717a234689558250aa52a1d4089c743f81411a51a99d90a2e1" name="a928284b47bbcad0717a234689558250aa52a1d4089c743f81411a51a99d90a2e1"></a>EditorsOnly <a id="a928284b47bbcad0717a234689558250aa59ffd36b33cc5de3325845c3353ec433" name="a928284b47bbcad0717a234689558250aa59ffd36b33cc5de3325845c3353ec433"></a>AllWindows 



<a id="a7c677ca4eca8285cae8730422280493e" name="a7c677ca4eca8285cae8730422280493e"></a>## [◆ ](#a7c677ca4eca8285cae8730422280493e)LicenseStatusType

 enum [ZOSAPI.LicenseStatusType](namespace_z_o_s_a_p_i.xhtml#a7c677ca4eca8285cae8730422280493e)

Usage (see [Example 10](page_ex10.xhtml) for a full sample)

C#

 // Save Ray Path Analysis to Text File

 if (TheApplication.LicenseStatus == [ZOSAPI](namespace_z_o_s_a_p_i.xhtml).LicenseStatusType.PremiumEdition)

 {

 IA_ RayPath = TheSystem.Analyses.New_Analysis(AnalysisIDM.PathAnalysis);

 [ZOSAPI.Analysis.RayTracing.IAS\_PathAnalysis](interface_z_o_s_a_p_i_1_1_analysis_1_1_ray_tracing_1_1_i_a_s___path_analysis.xhtml) RayPath_settings = RayPath.GetSettings() as [ZOSAPI](namespace_z_o_s_a_p_i.xhtml).[Analysis](namespace_z_o_s_a_p_i_1_1_analysis.xhtml).[RayTracing](namespace_z_o_s_a_p_i_1_1_analysis_1_1_ray_tracing.xhtml).[IAS\_PathAnalysis](interface_z_o_s_a_p_i_1_1_analysis_1_1_ray_tracing_1_1_i_a_s___path_analysis.xhtml);

 RayPath_settings.RayDatabaseFile = "e10\_API\_RayTrace.ZRD";

 RayPath.ApplyAndWaitForCompletion();

 IAR_ Rays = RayPath.GetResults();

 Rays.GetTextFile(TheApplication.SamplesDir + "\\\\API\\\\CS\\\\e10\_RayPathAnalysis.txt");

 }

 else

 {

 Console.Write("\\nThe RayPathAnalysis is a premium feature only\\n\\nPress any key to continue\\n");

 Console.ReadKey();

 }

[ZOSAPI.Analysis.RayTracing.IAS\_PathAnalysis](interface_z_o_s_a_p_i_1_1_analysis_1_1_ray_tracing_1_1_i_a_s___path_analysis.xhtml)

**Definition:** IAS_PathAnalysis.cs:40



[ZOSAPI.Analysis.RayTracing](namespace_z_o_s_a_p_i_1_1_analysis_1_1_ray_tracing.xhtml)

**Definition:** IAS_PathAnalysis.cs:10



[ZOSAPI.Analysis](namespace_z_o_s_a_p_i_1_1_analysis.xhtml)

**Definition:** IAS_FieldCurvatureAndDistortion.cs:5



[ZOSAPI](namespace_z_o_s_a_p_i.xhtml)

The ZOSAPI namespace contains classes for initially connecting to zemax. See also ZOSAPI_Connection,...

**Definition:** IAS_FieldCurvatureAndDistortion.cs:5





 C++

 // Save Ray Path Analysis to Text File

 if (TheApplication-&gt;LicenseStatus == ZOSAPI_Interfaces::LicenseStatusType::LicenseStatusType_PremiumEdition) {

 IA_Ptr RayPath = TheSystem-&gt;Analyses-&gt;New_Analysis(AnalysisIDM_PathAnalysis);

 ZOSAPI_Interfaces::IAS_PathAnalysisPtr RayPath_settings = RayPath-&gt;GetSettings();

 RayPath_settings-&gt;RayDatabaseFile = "e10\_API\_RayTrace.ZRD";

 RayPath-&gt;ApplyAndWaitForCompletion();

 

 IAR_Ptr Rays = RayPath-&gt;GetResults();

 Rays-&gt;GetTextFile(TheApplication-&gt;SamplesDir + "\\\\API\\\\CPP\\\\e10\_RayPathAnalysis.txt");

 }



 Matlab

 % Save Ray Path Analysis to Text File

 if TheApplication.LicenseStatus == [ZOSAPI](namespace_z_o_s_a_p_i.xhtml).LicenseStatusType.PremiumEdition

 RayPath = TheSystem.Analyses.New_Analysis([ZOSAPI](namespace_z_o_s_a_p_i.xhtml).[Analysis](namespace_z_o_s_a_p_i_1_1_analysis.xhtml).AnalysisIDM.PathAnalysis);

 RayPath_settings = RayPath.GetSettings();

 RayPath_settings.RayDatabaseFile = 'e10\_API\_Raytrace.ZRD';

 RayPath.ApplyAndWaitForCompletion();

 Rays = RayPath.GetResults();

 Rays.GetTextFile(System.String.Concat(TheApplication.SamplesDir, '\\API\\Matlab\\e10\_RayPathAnalysis.txt'));

 else

 fprintf('\\nThe RayPathAnalysis is a premium feature only\\n');

 end



 Python

 \# Save Ray Path Analysis to Text File

 if (TheApplication.LicenseStatus == ZOSAPI.LicenseStatusType.PremiumEdition):

 \# there is a bug in ZOS16.5 SP4 with COM; need to use ZOS16.5 SP5 or higher to run this code successfully

 RayPath = TheSystem.Analyses.New_Analysis(ZOSAPI.Analysis.AnalysisIDM.PathAnalysis)

 RayPath_settings = RayPath.GetSettings()

 zrd = "e10\_API\_RayTrace.ZRD"

 RayPath_settings.RayDatabaseFile = zrd

 RayPath.ApplyAndWaitForCompletion()

 

 Rays = RayPath.GetResults()

 Rays.GetTextFile(TheApplication.SamplesDir + "\\\\API\\\\Python\\\\e10\_RayPathAnalysis.txt")



 Enumerator<a id="a7c677ca4eca8285cae8730422280493ea88183b946cc5f0e8c96b2e66e1c74a7e" name="a7c677ca4eca8285cae8730422280493ea88183b946cc5f0e8c96b2e66e1c74a7e"></a>Unknown <a id="a7c677ca4eca8285cae8730422280493eae30c3d85ccc285b6c4cf428f13fc1bb2" name="a7c677ca4eca8285cae8730422280493eae30c3d85ccc285b6c4cf428f13fc1bb2"></a>KeyNotWorking <a id="a7c677ca4eca8285cae8730422280493ea63f7c30d809599bf49ef8d5d518f3ab8" name="a7c677ca4eca8285cae8730422280493ea63f7c30d809599bf49ef8d5d518f3ab8"></a>NewLicenseNeeded <a id="a7c677ca4eca8285cae8730422280493ea80bcaf4301377c8b5dcd277ca28a7bb4" name="a7c677ca4eca8285cae8730422280493ea80bcaf4301377c8b5dcd277ca28a7bb4"></a>StandardEdition <a id="a7c677ca4eca8285cae8730422280493ea2ed95be70a6ab6372a8dda3ebfd214d5" name="a7c677ca4eca8285cae8730422280493ea2ed95be70a6ab6372a8dda3ebfd214d5"></a>ProfessionalEdition <a id="a7c677ca4eca8285cae8730422280493ead7c251f26e809b1c6294fa8c0a69b4f5" name="a7c677ca4eca8285cae8730422280493ead7c251f26e809b1c6294fa8c0a69b4f5"></a>PremiumEdition <a id="a7c677ca4eca8285cae8730422280493eaa5ea7465492a8c5d19fbc46e789044b5" name="a7c677ca4eca8285cae8730422280493eaa5ea7465492a8c5d19fbc46e789044b5"></a>TooManyInstances <a id="a7c677ca4eca8285cae8730422280493ea418ec6476e1acd92e17681f4bd00e3a3" name="a7c677ca4eca8285cae8730422280493ea418ec6476e1acd92e17681f4bd00e3a3"></a>NotAuthorized <a id="a7c677ca4eca8285cae8730422280493eaa645e4cfc8d16be330607ad52aec5f98" name="a7c677ca4eca8285cae8730422280493eaa645e4cfc8d16be330607ad52aec5f98"></a>KeyNotFound <a id="a7c677ca4eca8285cae8730422280493ea3995421f2329ce6d6ba6b4ffad1e58ce" name="a7c677ca4eca8285cae8730422280493ea3995421f2329ce6d6ba6b4ffad1e58ce"></a>KeyExpired <a id="a7c677ca4eca8285cae8730422280493eac85a251cc457840f1e032f1b733e9398" name="a7c677ca4eca8285cae8730422280493eac85a251cc457840f1e032f1b733e9398"></a>Timeout <a id="a7c677ca4eca8285cae8730422280493ea97ab5524427a661ccb9cd7bb133dd4ff" name="a7c677ca4eca8285cae8730422280493ea97ab5524427a661ccb9cd7bb133dd4ff"></a>InstanceConflict <a id="a7c677ca4eca8285cae8730422280493ea0a55f5a93264f08c562bd0e8fa0f0e02" name="a7c677ca4eca8285cae8730422280493ea0a55f5a93264f08c562bd0e8fa0f0e02"></a>OpticsViewer <a id="a7c677ca4eca8285cae8730422280493ea095d0bde25fd250873df0bc05d84dd02" name="a7c677ca4eca8285cae8730422280493ea095d0bde25fd250873df0bc05d84dd02"></a>OpticStudioHPCEdition <a id="a7c677ca4eca8285cae8730422280493ea5fb4297717b3cc0d12b46f3f59fe9ecd" name="a7c677ca4eca8285cae8730422280493ea5fb4297717b3cc0d12b46f3f59fe9ecd"></a>EnterpriseEdition <a id="a7c677ca4eca8285cae8730422280493ea732e0ba6a7d77f2f69b03fe6a52edc6d" name="a7c677ca4eca8285cae8730422280493ea732e0ba6a7d77f2f69b03fe6a52edc6d"></a>StudentEdition 



<a id="a0bbab31714d9ab6077ce3a689a286f42" name="a0bbab31714d9ab6077ce3a689a286f42"></a>## [◆ ](#a0bbab31714d9ab6077ce3a689a286f42)SessionModes

 enum [ZOSAPI.SessionModes](namespace_z_o_s_a_p_i.xhtml#a0bbab31714d9ab6077ce3a689a286f42)

Enumerator<a id="a0bbab31714d9ab6077ce3a689a286f42a8e0a81536e3612d31a704c3ece62a68f" name="a0bbab31714d9ab6077ce3a689a286f42a8e0a81536e3612d31a704c3ece62a68f"></a>FromPreferences <a id="a0bbab31714d9ab6077ce3a689a286f42a1f6ef1cc58fdff6cdfd7c8f5dda169ad" name="a0bbab31714d9ab6077ce3a689a286f42a1f6ef1cc58fdff6cdfd7c8f5dda169ad"></a>SessionOn <a id="a0bbab31714d9ab6077ce3a689a286f42a5735ac012ce18416658c0d7462c32be8" name="a0bbab31714d9ab6077ce3a689a286f42a5735ac012ce18416658c0d7462c32be8"></a>SessionOff 



<a id="a55b9060ae2fffe30bd5c6cb28e8cd164" name="a55b9060ae2fffe30bd5c6cb28e8cd164"></a>## [◆ ](#a55b9060ae2fffe30bd5c6cb28e8cd164)STARUpdateMode

 enum [ZOSAPI.STARUpdateMode](namespace_z_o_s_a_p_i.xhtml#a55b9060ae2fffe30bd5c6cb28e8cd164)

Enumerator<a id="a55b9060ae2fffe30bd5c6cb28e8cd164a960b44c579bc2f6818d2daaf9e4c16f0" name="a55b9060ae2fffe30bd5c6cb28e8cd164a960b44c579bc2f6818d2daaf9e4c16f0"></a>Normal <a id="a55b9060ae2fffe30bd5c6cb28e8cd164a8bf906833cc7aea8084f552217ed9c1d" name="a55b9060ae2fffe30bd5c6cb28e8cd164a8bf906833cc7aea8084f552217ed9c1d"></a>Suspended 



<a id="a3c37540f7b61a272f4eb50e826d27daf" name="a3c37540f7b61a272f4eb50e826d27daf"></a>## [◆ ](#a3c37540f7b61a272f4eb50e826d27daf)SystemType

 enum [ZOSAPI.SystemType](namespace_z_o_s_a_p_i.xhtml#a3c37540f7b61a272f4eb50e826d27daf)

Enumerator<a id="a3c37540f7b61a272f4eb50e826d27dafaa7e82daa7280af25afbaa076ac16eb1e" name="a3c37540f7b61a272f4eb50e826d27dafaa7e82daa7280af25afbaa076ac16eb1e"></a>Sequential <a id="a3c37540f7b61a272f4eb50e826d27dafa12d3de3f72d530905c690c2750951117" name="a3c37540f7b61a272f4eb50e826d27dafa12d3de3f72d530905c690c2750951117"></a>NonSequential 



<a id="ae1500a9901bf1c5a361d63d4fac19d9a" name="ae1500a9901bf1c5a361d63d4fac19d9a"></a>## [◆ ](#ae1500a9901bf1c5a361d63d4fac19d9a)UpdateStatus

 enum [ZOSAPI.UpdateStatus](namespace_z_o_s_a_p_i.xhtml#ae1500a9901bf1c5a361d63d4fac19d9a)

Enumerator<a id="ae1500a9901bf1c5a361d63d4fac19d9aa67964924cf2737ff8335b0fed52d430f" name="ae1500a9901bf1c5a361d63d4fac19d9aa67964924cf2737ff8335b0fed52d430f"></a>CheckFailed <a id="ae1500a9901bf1c5a361d63d4fac19d9aa9ed2d871602556951e39f3cebd08d6cb" name="ae1500a9901bf1c5a361d63d4fac19d9aa9ed2d871602556951e39f3cebd08d6cb"></a>NotSupported <a id="ae1500a9901bf1c5a361d63d4fac19d9aac9c0fcb2bb86adc799c4b7eb02412379" name="ae1500a9901bf1c5a361d63d4fac19d9aac9c0fcb2bb86adc799c4b7eb02412379"></a>NotChecked <a id="ae1500a9901bf1c5a361d63d4fac19d9aa761266b390b3dc960c74d9194512850a" name="ae1500a9901bf1c5a361d63d4fac19d9aa761266b390b3dc960c74d9194512850a"></a>UpToDate <a id="ae1500a9901bf1c5a361d63d4fac19d9aad7c00931b9215da584bea3cc46e9d52e" name="ae1500a9901bf1c5a361d63d4fac19d9aad7c00931b9215da584bea3cc46e9d52e"></a>AvailableEligible <a id="ae1500a9901bf1c5a361d63d4fac19d9aabf78d5d426412bd40a10e886e14da89c" name="ae1500a9901bf1c5a361d63d4fac19d9aabf78d5d426412bd40a10e886e14da89c"></a>AvailableIneligible 



<a id="a254f5f6cb4ff37c2245b456b9bb79d2a" name="a254f5f6cb4ff37c2245b456b9bb79d2a"></a>## [◆ ](#a254f5f6cb4ff37c2245b456b9bb79d2a)ZOSAPI\_Mode

 enum [ZOSAPI.ZOSAPI\_Mode](namespace_z_o_s_a_p_i.xhtml#a254f5f6cb4ff37c2245b456b9bb79d2a)

Enumerator<a id="a254f5f6cb4ff37c2245b456b9bb79d2aa9aa1b03934893d7134a660af4204f2a9" name="a254f5f6cb4ff37c2245b456b9bb79d2aa9aa1b03934893d7134a660af4204f2a9"></a>Server The connection is running in server or headless mode.

<a id="a254f5f6cb4ff37c2245b456b9bb79d2aa1b488933c47964ca059d24f978f094e4" name="a254f5f6cb4ff37c2245b456b9bb79d2aa1b488933c47964ca059d24f978f094e4"></a>Operand User operand mode.

<a id="a254f5f6cb4ff37c2245b456b9bb79d2aa409c1892b68cb394799262ac57f6d4f1" name="a254f5f6cb4ff37c2245b456b9bb79d2aa409c1892b68cb394799262ac57f6d4f1"></a>Plugin Extension mode.

<a id="a254f5f6cb4ff37c2245b456b9bb79d2aa64eebbd15ce06c7625d3e50c3d7b2cbd" name="a254f5f6cb4ff37c2245b456b9bb79d2aa64eebbd15ce06c7625d3e50c3d7b2cbd"></a>UserAnalysis User analysis mode – perform the calculation.

<a id="a254f5f6cb4ff37c2245b456b9bb79d2aab71755803158960255ee23dc613d4ac2" name="a254f5f6cb4ff37c2245b456b9bb79d2aab71755803158960255ee23dc613d4ac2"></a>UserAnalysisSettings User analysis mode – display/configure the analysis settings.





## Function Documentation

<a id="afaf981c5f923ffd5800be6562f3ebc0a" name="afaf981c5f923ffd5800be6562f3ebc0a"></a>## [◆ ](#afaf981c5f923ffd5800be6562f3ebc0a)OpticalSystemStatusChangedHandler()

 delegate void ZOSAPI.OpticalSystemStatusChangedHandler  ( int  *systemId*,    string  *newStatus*   )