Class UserParametersListHelper

Helper methods for ICamIpcUserParametersList

Inheritance

object

UserParametersListHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: CAMIPC.DotnetHelper

Assembly: CAMIPC.DotnetHelper.dll

Syntax

public static class UserParametersListHelper

Methods

Add(ComWrapper<ICamIpcUserParametersList>, string, string, string)

Add a parameter. If a parameter with the same name already exists, its Value and Comment are updated. Returns the added or updated parameter. Throws when the name is not one the core accepts.

Declaration

public static ComWrapper<ICamIpcUserParameter> Add(this ComWrapper<ICamIpcUserParametersList> listCom, string name, string value, string comment = "")

Parameters

Type	Name	Description
ComWrapper<ICamIpcUserParametersList>	listCom
string	name
string	value
string	comment

Returns

Type	Description
ComWrapper<ICamIpcUserParameter>

Count(ComWrapper<ICamIpcUserParametersList>)

Number of user parameters.

Declaration

public static int Count(this ComWrapper<ICamIpcUserParametersList> listCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcUserParametersList>	listCom

Returns

Type	Description
int

Delete(ComWrapper<ICamIpcUserParametersList>, string)

Delete the parameter with the given name. Returns false if there was no such parameter.

Declaration

public static bool Delete(this ComWrapper<ICamIpcUserParametersList> listCom, string name)

Parameters

Type	Name	Description
ComWrapper<ICamIpcUserParametersList>	listCom
string	name

Returns

Type	Description
bool

FindByName(ComWrapper<ICamIpcUserParametersList>, string)

Parameter with the given name, or a wrapper around nil (check IsNull) if not found.

Declaration

public static ComWrapper<ICamIpcUserParameter> FindByName(this ComWrapper<ICamIpcUserParametersList> listCom, string name)

Parameters

Type	Name	Description
ComWrapper<ICamIpcUserParametersList>	listCom
string	name

Returns

Type	Description
ComWrapper<ICamIpcUserParameter>

GetItem(ComWrapper<ICamIpcUserParametersList>, int)

Parameter at the given index. Throws if the index is out of range.

Declaration

public static ComWrapper<ICamIpcUserParameter> GetItem(this ComWrapper<ICamIpcUserParametersList> listCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamIpcUserParametersList>	listCom
int	index

Returns

Type	Description
ComWrapper<ICamIpcUserParameter>

IndexOf(ComWrapper<ICamIpcUserParametersList>, string)

Index of the parameter with the given name, or -1 if not found.

Declaration

public static int IndexOf(this ComWrapper<ICamIpcUserParametersList> listCom, string name)

Parameters

Type	Name	Description
ComWrapper<ICamIpcUserParametersList>	listCom
string	name

Returns

Type	Description
int