NSArray.ArrayFromHandle Method

Definition

Namespace:: Foundation

Assembly:: Microsoft.iOS.dll

Assembly:: Microsoft.MacCatalyst.dll

Assembly:: Microsoft.macOS.dll

Assembly:: Microsoft.tvOS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

Name	Description
ArrayFromHandle<T>(NativeHandle)	Returns a strongly-typed C# array of the parametrized type from a handle to an NSArray.
ArrayFromHandle<T>(NativeHandle, Boolean)	Returns a strongly-typed C# array of the parametrized type from a handle to an NSArray.
ArrayFromHandle<T>(NativeHandle, Converter<NativeHandle,T>)	Returns a strongly-typed C# array of the parametrized type from a handle to an NSArray.
ArrayFromHandle<T>(NativeHandle, Converter<NativeHandle,T>, Boolean)	Returns a strongly-typed C# array of the parametrized type from a handle to an NSArray.

ArrayFromHandle<T>(NativeHandle)

Returns a strongly-typed C# array of the parametrized type from a handle to an NSArray.

public static T[] ArrayFromHandle<T>(ObjCRuntime.NativeHandle handle) where T : class, ObjCRuntime.INativeObject;

public static T?[]? ArrayFromHandle<T>(ObjCRuntime.NativeHandle handle) where T : class, ObjCRuntime.INativeObject;

static member ArrayFromHandle : ObjCRuntime.NativeHandle -> 'T[] (requires 'T : null and 'T :> ObjCRuntime.INativeObject)

Type Parameters

T

Parameter type, determines the kind of array returned.

Parameters

handle: NativeHandle

Pointer (handle) to the unmanaged object.

Returns

T[]

An C# array with the values.

Remarks

NativeHandle someHandle = ...;
var values = NSArray.ArrayFromHandle<NSString> (someHandle);

Applies to

ArrayFromHandle<T>(NativeHandle, Boolean)

Returns a strongly-typed C# array of the parametrized type from a handle to an NSArray.

public static T?[]? ArrayFromHandle<T>(ObjCRuntime.NativeHandle handle, bool releaseHandle) where T : class, ObjCRuntime.INativeObject;

static member ArrayFromHandle : ObjCRuntime.NativeHandle * bool -> 'T[] (requires 'T : null and 'T :> ObjCRuntime.INativeObject)

Type Parameters

T

Parameter type, determines the kind of array returned.

Parameters

handle: NativeHandle

Pointer (handle) to the unmanaged object.

releaseHandle: Boolean

Whether the native NSArray instance should be released before returning or not.

Returns

T[]

A C# array with the values.

Remarks

var someHandle = GetCopyOfNativeArray (...);
var values = NSArray.ArrayFromHandle<NSString> (someHandle, releaseHandle: true);

Applies to

ArrayFromHandle<T>(NativeHandle, Converter<NativeHandle,T>)

Returns a strongly-typed C# array of the parametrized type from a handle to an NSArray.

public static T[] ArrayFromHandle<T>(ObjCRuntime.NativeHandle handle, Converter<ObjCRuntime.NativeHandle,T> creator);

public static T?[]? ArrayFromHandle<T>(ObjCRuntime.NativeHandle handle, Converter<ObjCRuntime.NativeHandle,T> creator);

static member ArrayFromHandle : ObjCRuntime.NativeHandle * Converter<ObjCRuntime.NativeHandle, 'T> -> 'T[]

Type Parameters

T

Parameter type, determines the kind of array returned.

Parameters

handle: NativeHandle

Pointer (handle) to the unmanaged object.

creator: Converter<NativeHandle,T>

Method that can create objects of type T from a given IntPtr.

Returns

T[]

An C# array with the values.

Remarks

int myCreator (IntPtr v)
{
	return (int) v;
}

var args = NSArray.ArrayFromHandle<int> (someHandle, myCreator);

Applies to

ArrayFromHandle<T>(NativeHandle, Converter<NativeHandle,T>, Boolean)

Returns a strongly-typed C# array of the parametrized type from a handle to an NSArray.

public static T[] ArrayFromHandle<T>(ObjCRuntime.NativeHandle handle, Converter<ObjCRuntime.NativeHandle,T> creator, bool releaseHandle);

public static T?[]? ArrayFromHandle<T>(ObjCRuntime.NativeHandle handle, Converter<ObjCRuntime.NativeHandle,T> creator, bool releaseHandle);

static member ArrayFromHandle : ObjCRuntime.NativeHandle * Converter<ObjCRuntime.NativeHandle, 'T> * bool -> 'T[]

Type Parameters

T

Parameter type, determines the kind of array returned.

Parameters

handle: NativeHandle

Pointer (handle) to the unmanaged object.

creator: Converter<NativeHandle,T>

Method that can create objects of type T from a given handle.

releaseHandle: Boolean

Whether the native NSArray instance should be released before returning or not.

Returns

T[]

A C# array with the values, or null if the handle is Zero.

Applies to