Class XmlPropArrayHelper

Helper methods for ICamIpcXmlPropArray

Inheritance

object

XmlPropArrayHelper

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 XmlPropArrayHelper

Methods

AddItem(ComWrapper<ICamIpcXmlPropArray>, ComWrapper<ICamIpcXmlPropPointer>)

Append an item to the array and return its index.

Declaration

public static int AddItem(this ComWrapper<ICamIpcXmlPropArray> arrayCom, ComWrapper<ICamIpcXmlPropPointer> itemCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcXmlPropArray>	arrayCom
ComWrapper<ICamIpcXmlPropPointer>	itemCom

Returns

Type	Description
int

Clear(ComWrapper<ICamIpcXmlPropArray>)

Remove every item from the array.

Declaration

public static void Clear(this ComWrapper<ICamIpcXmlPropArray> arrayCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcXmlPropArray>	arrayCom

CreateNewItem(ComWrapper<ICamIpcXmlPropArray>, string)

Create a new item of the given type, if items of this type are allowed in the array.

Declaration

public static ComWrapper<ICamIpcXmlPropPointer> CreateNewItem(this ComWrapper<ICamIpcXmlPropArray> arrayCom, string id)

Parameters

Type	Name	Description
ComWrapper<ICamIpcXmlPropArray>	arrayCom
string	id

Returns

Type	Description
ComWrapper<ICamIpcXmlPropPointer>

Delete(ComWrapper<ICamIpcXmlPropArray>, int)

Delete the item at the given index.

Declaration

public static void Delete(this ComWrapper<ICamIpcXmlPropArray> arrayCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamIpcXmlPropArray>	arrayCom
int	index

ExtractItem(ComWrapper<ICamIpcXmlPropArray>, int)

Remove the item at the given index from the array and return it.

Declaration

public static ComWrapper<ICamIpcXmlPropPointer> ExtractItem(this ComWrapper<ICamIpcXmlPropArray> arrayCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamIpcXmlPropArray>	arrayCom
int	index

Returns

Type	Description
ComWrapper<ICamIpcXmlPropPointer>

IndexOf(ComWrapper<ICamIpcXmlPropArray>, ComWrapper<ICamIpcXmlPropPointer>)

Index of the item in the array, or -1 when it is not there.

Declaration

public static int IndexOf(this ComWrapper<ICamIpcXmlPropArray> arrayCom, ComWrapper<ICamIpcXmlPropPointer> itemCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcXmlPropArray>	arrayCom
ComWrapper<ICamIpcXmlPropPointer>	itemCom

Returns

Type	Description
int

Insert(ComWrapper<ICamIpcXmlPropArray>, ComWrapper<ICamIpcXmlPropPointer>, int)

Insert an item at the given index, shifting subsequent elements.

Declaration

public static void Insert(this ComWrapper<ICamIpcXmlPropArray> arrayCom, ComWrapper<ICamIpcXmlPropPointer> itemCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamIpcXmlPropArray>	arrayCom
ComWrapper<ICamIpcXmlPropPointer>	itemCom
int	index

InstanceId(ComWrapper<ICamIpcXmlPropArray>)

Unique identifier of the instance, as used in IPC messages.

Declaration

public static string InstanceId(this ComWrapper<ICamIpcXmlPropArray> arrayCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcXmlPropArray>	arrayCom

Returns

Type	Description
string

Itm(ComWrapper<ICamIpcXmlPropArray>, int)

Array element by index.

Declaration

public static ComWrapper<ICamIpcXmlPropPointer> Itm(this ComWrapper<ICamIpcXmlPropArray> arrayCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamIpcXmlPropArray>	arrayCom
int	index

Returns

Type	Description
ComWrapper<ICamIpcXmlPropPointer>

SetTopItem(ComWrapper<ICamIpcXmlPropArray>, int)

Set the index of the last array item.

Declaration

public static void SetTopItem(this ComWrapper<ICamIpcXmlPropArray> arrayCom, int value)

Parameters

Type	Name	Description
ComWrapper<ICamIpcXmlPropArray>	arrayCom
int	value

TopItem(ComWrapper<ICamIpcXmlPropArray>)

Index of the last array item.

Declaration

public static int TopItem(this ComWrapper<ICamIpcXmlPropArray> arrayCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcXmlPropArray>	arrayCom

Returns

Type	Description
int