RTI Connext C# API  6.1.0
InstanceHandle Struct Reference

Handle to identity different instances of the same Topics.Topic<T> of a certain type. More...

Inherits IEquatable< InstanceHandle >, and IComparable< InstanceHandle >.

Public Member Functions

bool IsNil ()
 Compare this handle to Nil More...
 
bool Equals (InstanceHandle other)
 Compares this instance handle with another handle for equality. More...
 
int CompareTo (InstanceHandle other)
 Compares this instance handle with another handle. More...
 
override bool Equals (object obj)
 Compares this instance handle with another handle for equality. More...
 
override int GetHashCode ()
 Generates a hash code from this InstanceHandle. More...
 
override string ToString ()
 Returns a string representation of this InstanceHandle More...
 
byte[] ToArray ()
 Converts this instance handle to a byte array. More...
 

Static Public Member Functions

static InstanceHandle FromArray (byte[] bytes)
 Creates a non-Nil InstanceHandle from the bytes in a 16-byte array More...
 

Properties

static InstanceHandle Nil [get]
 The NIL instance handle. More...
 

Detailed Description

Handle to identity different instances of the same Topics.Topic<T> of a certain type.

The full documentation is available in the C API: DDS_InstanceHandle_t

Member Function Documentation

◆ CompareTo()

int CompareTo ( InstanceHandle  other)

Compares this instance handle with another handle.

The full documentation is available in the C API: DDS_InstanceHandle_compare

◆ Equals() [1/2]

bool Equals ( InstanceHandle  other)

Compares this instance handle with another handle for equality.

The full documentation is available in the C API: DDS_InstanceHandle_equals

◆ Equals() [2/2]

override bool Equals ( object  obj)

Compares this instance handle with another handle for equality.

The full documentation is available in the C API: DDS_InstanceHandle_equals

◆ FromArray()

static InstanceHandle FromArray ( byte[]  bytes)
static

Creates a non-Nil InstanceHandle from the bytes in a 16-byte array

◆ GetHashCode()

override int GetHashCode ( )

Generates a hash code from this InstanceHandle.

◆ IsNil()

bool IsNil ( )

Compare this handle to Nil

The full documentation is available in the C API: DDS_InstanceHandle_is_nil

◆ ToArray()

byte [] ToArray ( )

Converts this instance handle to a byte array.

◆ ToString()

override string ToString ( )

Returns a string representation of this InstanceHandle

Property Documentation

◆ Nil

InstanceHandle Nil
staticget

The NIL instance handle.

The full documentation is available in the C API: DDS_HANDLE_NIL