Skip to main content

Zemax OpticStudio ZOS-API 2026 R1

Interface ZOSAPI::Common::IMetadata

Last update: 13.03.2026

Definition:

Members

Properties

Property NumberOfKeys

Definition:

int ZOSAPI.Common.IMetadata.NumberOfKeys

Return type: int

Public functions

Function GetKeyName

string ZOSAPI.Common.IMetadata.GetKeyName(int keyNumber)

Parameters:

  • keyNumber: A 1-based key number (i.e., valid values are 1..NumberOfKeys (inclusive)).

Parameters:

  • int keyNumber

Return type: string

Function GetData

string ZOSAPI.Common.IMetadata.GetData(string key)

Parameters:

  • string key

Return type: string

Function SetData

void ZOSAPI.Common.IMetadata.SetData(string key, string value)

Parameters:

  • string key
  • string value

Return type: void

Function RemoveData

bool ZOSAPI.Common.IMetadata.RemoveData(string key)

Parameters:

  • string key

Return type: bool

Function ConvertFromBinary

string ZOSAPI.Common.IMetadata.ConvertFromBinary(byte[] data)

Parameters:

  • byte[] data

Return type: string

Function ConvertToBinary

byte[] ZOSAPI.Common.IMetadata.ConvertToBinary(string s)

Parameters:

  • string s

Return type: byte[]

Function CreateGuid

string ZOSAPI.Common.IMetadata.CreateGuid()

Return type: string

Connect with Ansys