GCHandle

Overview

GC handles are handles to an object that are kept in memory even if they're not referenced by anything the GC can found. This can be used to hold objects in non managed memory. GC Handles need to be explicitly freed.

Location

Reference: Island.fx
Namespace: RemObjects.Elements.System
Ancestry: ValueType | GCHandle

constructor protected (declared in ValueType)

constructor

GCHandle()

init()

GCHandle()

Sub New()

constructor (NativeInt)

constructor(aHandle: NativeInt)

GCHandle(NativeInt aHandle)

init(_ aHandle: NativeInt)

GCHandle(NativeInt aHandle)

Sub New(aHandle As NativeInt)

Parameters:

aHandle:

Allocate

Allocates a gc handle for an object.

class method Allocate(aValue: Object): GCHandle

static GCHandle Allocate(Object aValue)

static func Allocate(_ aValue: Object) -> GCHandle

static GCHandle Allocate(Object aValue)

Shared Function Allocate(aValue As Object) As GCHandle

Parameters:

aValue:

Dispose

method Dispose

void Dispose()

func Dispose()

void Dispose()

Sub Dispose()

Equals virtual (declared in Object)

Default constructor.

method Equals(aOther: Object): Boolean

Boolean Equals(Object aOther)

func Equals(_ aOther: Object) -> Boolean

Boolean Equals(Object aOther)

Function Equals(aOther As Object) As Boolean

Parameters:

aOther: the reference to compare this with.

Finalize protected virtual (declared in Object)

method Finalize

void Finalize()

func Finalize()

void Finalize()

Sub Finalize()

GetHashCode virtual (declared in Object)

Returns a hashcode for this object. Overriden implementations should make sure that the number returned here is constant given the same object.

method GetHashCode: Int32

Int32 GetHashCode()

func GetHashCode() -> Int32

Int32 GetHashCode()

Function GetHashCode() As Int32

GetType (declared in Object)

Returns the actual type of this class

method GetType: Type

Type GetType()

func GetType() -> Type

Type GetType()

Function GetType() As Type

Handle

Returns the handle value. This number has no relation to the object referenced, other than thhrough the GC Handles.

property Handle: NativeInt read;

NativeInt Handle { get; }

var Handle: NativeInt { get{} }

NativeInt Handle { __get; }

ReadOnly Property Handle() As NativeInt

HasValue

Returns true if this handle has a value.

property HasValue: Boolean read;

Boolean HasValue { get; }

var HasValue: Boolean { get{} }

Boolean HasValue { __get; }

ReadOnly Property HasValue() As Boolean

ReferenceEquals (declared in Object)

Compares two references for equivalence (even if they have an equals operator)

class method ReferenceEquals(a: Object; b: Object): Boolean

static Boolean ReferenceEquals(Object a, Object b)

static func ReferenceEquals(_ a: Object, _ b: Object) -> Boolean

static Boolean ReferenceEquals(Object a, Object b)

Shared Function ReferenceEquals(a As Object, b As Object) As Boolean

Parameters:

a: left value
b: right value

Target

Returns the value for this GC handle.

property Target: Object read;

Object Target { get; }

var Target: Object { get{} }

Object Target { __get; }

ReadOnly Property Target() As Object

ToString virtual (declared in Object)

Gets the string representation of this method.

method ToString: String

String ToString()

func ToString() -> String

String ToString()

Function ToString() As String

Handle

Returns the handle value. This number has no relation to the object referenced, other than thhrough the GC Handles.

property Handle: NativeInt read;

NativeInt Handle { get; }

var Handle: NativeInt { get{} }

NativeInt Handle { __get; }

ReadOnly Property Handle() As NativeInt

HasValue

Returns true if this handle has a value.

property HasValue: Boolean read;

Boolean HasValue { get; }

var HasValue: Boolean { get{} }

Boolean HasValue { __get; }

ReadOnly Property HasValue() As Boolean

Target

Returns the value for this GC handle.

property Target: Object read;

Object Target { get; }

var Target: Object { get{} }

Object Target { __get; }

ReadOnly Property Target() As Object

Allocate

Allocates a gc handle for an object.

class method Allocate(aValue: Object): GCHandle

static GCHandle Allocate(Object aValue)

static func Allocate(_ aValue: Object) -> GCHandle

static GCHandle Allocate(Object aValue)

Shared Function Allocate(aValue As Object) As GCHandle

Parameters:

aValue:

ReferenceEquals (declared in Object)

Compares two references for equivalence (even if they have an equals operator)

class method ReferenceEquals(a: Object; b: Object): Boolean

static Boolean ReferenceEquals(Object a, Object b)

static func ReferenceEquals(_ a: Object, _ b: Object) -> Boolean

static Boolean ReferenceEquals(Object a, Object b)

Shared Function ReferenceEquals(a As Object, b As Object) As Boolean

Parameters:

a: left value
b: right value

constructor protected (declared in ValueType)

constructor

GCHandle()

init()

GCHandle()

Sub New()

constructor (NativeInt)

constructor(aHandle: NativeInt)

GCHandle(NativeInt aHandle)

init(_ aHandle: NativeInt)

GCHandle(NativeInt aHandle)

Sub New(aHandle As NativeInt)

Parameters:

aHandle:

Dispose

method Dispose

void Dispose()

func Dispose()

void Dispose()

Sub Dispose()

Equals virtual (declared in Object)

Default constructor.

method Equals(aOther: Object): Boolean

Boolean Equals(Object aOther)

func Equals(_ aOther: Object) -> Boolean

Boolean Equals(Object aOther)

Function Equals(aOther As Object) As Boolean

Parameters:

aOther: the reference to compare this with.

Finalize protected virtual (declared in Object)

method Finalize

void Finalize()

func Finalize()

void Finalize()

Sub Finalize()

GetHashCode virtual (declared in Object)

Returns a hashcode for this object. Overriden implementations should make sure that the number returned here is constant given the same object.

method GetHashCode: Int32

Int32 GetHashCode()

func GetHashCode() -> Int32

Int32 GetHashCode()

Function GetHashCode() As Int32

GetType (declared in Object)

Returns the actual type of this class

method GetType: Type

Type GetType()

func GetType() -> Type

Type GetType()

Function GetType() As Type

ToString virtual (declared in Object)

Gets the string representation of this method.

method ToString: String

String ToString()

func ToString() -> String

String ToString()

Function ToString() As String

IDisposable