Interface ZOSAPI::Preferences::IPreferencesFolders
Last update: 13.03.2026
Definition:
Allows configuration of settings from the OpticStudio Preferences -> Folders tab in OpticStudio.
Note - every time a setting is changed the Preference file in use will be automatically saved, but only if a valid file name is defined for IZOSAPI_Connection.PreferencesFile prior to connecting to the ZOS-API. The excpetion however is the DataDirectory field; it is global, so changing that will effect all OpticStudio users.
Members
- ChangeDataDirectory
- CoatingDirectory
- CreoDirectory
- CreoInstallDirectory
- DataDirectory
- GlassDirectory
- ImagesDirectory
- InventorDirectory
- LensDirectory
- MatlabDirectory
- ObjectsDirectory
- PopDirectory
- ProgramDirectory
- ScatterDirectory
- SolidWorksDirectory
- UndoDirectory
- ZplDirectory
Properties
Property ProgramDirectory
Definition:
string ZOSAPI.Preferences.IPreferencesFolders.ProgramDirectory
Return type: string
Property DataDirectory
Definition:
string ZOSAPI.Preferences.IPreferencesFolders.DataDirectory
Return type: string
Property LensDirectory
Definition:
string ZOSAPI.Preferences.IPreferencesFolders.LensDirectory
Return type: string
Property ObjectsDirectory
Definition:
string ZOSAPI.Preferences.IPreferencesFolders.ObjectsDirectory
Return type: string
Property ZplDirectory
Definition:
string ZOSAPI.Preferences.IPreferencesFolders.ZplDirectory
Return type: string
Property GlassDirectory
Definition:
string ZOSAPI.Preferences.IPreferencesFolders.GlassDirectory
Return type: string
Property CoatingDirectory
Definition:
string ZOSAPI.Preferences.IPreferencesFolders.CoatingDirectory
Return type: string
Property PopDirectory
Definition:
string ZOSAPI.Preferences.IPreferencesFolders.PopDirectory
Return type: string
Property ImagesDirectory
Definition:
string ZOSAPI.Preferences.IPreferencesFolders.ImagesDirectory
Return type: string
Property SolidWorksDirectory
Definition:
string ZOSAPI.Preferences.IPreferencesFolders.SolidWorksDirectory
Return type: string
Property InventorDirectory
Definition:
string ZOSAPI.Preferences.IPreferencesFolders.InventorDirectory
Return type: string
Property CreoDirectory
Definition:
string ZOSAPI.Preferences.IPreferencesFolders.CreoDirectory
Return type: string
Property MatlabDirectory
Definition:
string ZOSAPI.Preferences.IPreferencesFolders.MatlabDirectory
Return type: string
Property ScatterDirectory
Definition:
string ZOSAPI.Preferences.IPreferencesFolders.ScatterDirectory
Return type: string
Property UndoDirectory
Definition:
string ZOSAPI.Preferences.IPreferencesFolders.UndoDirectory
Return type: string
Property CreoInstallDirectory
Definition:
string ZOSAPI.Preferences.IPreferencesFolders.CreoInstallDirectory
Return type: string
Public functions
Function ChangeDataDirectory
void ZOSAPI.Preferences.IPreferencesFolders.ChangeDataDirectory(string newDirectory)
Parameters:
- string newDirectory
Return type: void
