Class PvStringList

Managed list of strings used by the eBUS SDK for device and stream metadata.

Inheritance

object

PvStringList

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: eBUSDotNet

Assembly: eBUSDotNet.dll

Syntax

public class PvStringList : IDisposable

Constructors

PvStringList()

Constructor.

Declaration

public PvStringList()

Fields

swigCMemOwn

Determines who is responsible for deleting the underlying C++ object.

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
bool

Properties

this[uint]

Gets the string at the specified index.

Declaration

public virtual string this[uint aIndex] { get; set; }

Parameters

Type	Name	Description
uint	aIndex	Zero-based index of the string to retrieve.

Property Value

Type	Description
string	The string at the specified index.

PvSize

Gets the number of strings in the list.

Declaration

public uint PvSize { get; }

Property Value

Type	Description
uint

Methods

Add(string)

Adds a string to the end of the list.

Declaration

public void Add(string aString)

Parameters

Type	Name	Description
string	aString	The string to add.

Clear()

Removes all strings from the list.

Declaration

public void Clear()

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~PvStringList()

Destructor.

Declaration

protected ~PvStringList()

GetFirst()

Gets the first string in the list.

Declaration

public string GetFirst()

Returns

Type	Description
string	The first string, or empty string if the list is empty.

GetItem(uint)

Gets the string at the specified index.

Declaration

public string GetItem(uint aIndex)

Parameters

Type	Name	Description
uint	aIndex	Zero-based index of the string to retrieve.

Returns

Type	Description
string	The string at the specified index.

GetNext()

Gets the next string in the list during iteration.

Declaration

public string GetNext()

Returns

Type	Description
string	The next string, or empty string if at the end.

Implements

IDisposable