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.). More...

Public Member Functions
string[]	GetKeys ()
	Gets an array of all keys currently stored.

bool	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.

bool	GetDoubleValue (string key, [Out]out double val)

bool	GetIntegerValue (string key, [Out]out int val)

bool	GetFloatValue (string key, [Out]out float val)

bool	GetStringValue (string key, [Out]out string val)

bool	GetByteValue (string key, [Out]out byte val)

bool	GetBooleanValue (string key, [Out]out bool val)

void	SetDoubleValue (string key, [In]double val)

void	SetIntegerValue (string key, [In]int val)

void	SetFloatValue (string key, [In]float val)

void	SetStringValue (string key, [In]string val)

void	SetByteValue (string key, [In]byte val)

void	SetBooleanValue (string key, [In]bool val)

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

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

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

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

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

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

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

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

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

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

Properties
int	NumberOfSettings `[get]`
	Gets the total number of settings currently stored via the API.

Detailed Description

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.).

Member Function Documentation

◆ GetBooleanArray()

bool ZOSAPI.Common.ISettingsData.GetBooleanArray	(	string	key,
		int	Size,
		[In, Out] bool[]	val
	)

◆ GetBooleanValue()

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

◆ GetByteArray()

bool ZOSAPI.Common.ISettingsData.GetByteArray	(	string	key,
		int	Size,
		[In, Out] byte[]	val
	)

◆ GetByteValue()

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

◆ GetDoubleArray()

bool ZOSAPI.Common.ISettingsData.GetDoubleArray	(	string	key,
		int	Size,
		[In, Out] double[]	val
	)

◆ GetDoubleValue()

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

◆ 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.

◆ GetFloatArray()

bool ZOSAPI.Common.ISettingsData.GetFloatArray	(	string	key,
		int	Size,
		[In, Out] float[]	val
	)

◆ GetFloatValue()

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

◆ GetIntegerArray()

bool ZOSAPI.Common.ISettingsData.GetIntegerArray	(	string	key,
		int	Size,
		[In, Out] int[]	val
	)

◆ GetIntegerValue()

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

◆ GetKeys()

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

Gets an array of all keys currently stored.

Returns

◆ GetStringValue()

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

◆ SetBooleanArray()

void ZOSAPI.Common.ISettingsData.SetBooleanArray	(	string	key,
		int	Size,
		[In] bool[]	val
	)

◆ SetBooleanValue()

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

◆ SetByteArray()

void ZOSAPI.Common.ISettingsData.SetByteArray	(	string	key,
		int	Size,
		[In] byte[]	val
	)

◆ SetByteValue()

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

◆ SetDoubleArray()

void ZOSAPI.Common.ISettingsData.SetDoubleArray	(	string	key,
		int	Size,
		[In] double[]	val
	)

◆ SetDoubleValue()

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

◆ SetFloatArray()

void ZOSAPI.Common.ISettingsData.SetFloatArray	(	string	key,
		int	Size,
		[In] float[]	val
	)

◆ SetFloatValue()

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

◆ SetIntegerArray()

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

◆ SetIntegerValue()

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

◆ SetStringValue()

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

Property Documentation

◆ NumberOfSettings

int ZOSAPI.Common.ISettingsData.NumberOfSettings

get

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

The number of settings.

ZOS-API interface 2025 R2

ZOSAPI.Common.ISettingsData Interface Reference

Public Member Functions

Properties