Unsafe.AddByteOffset Method

Definition

Namespace:

System.Runtime.CompilerServices

Assembly:

System.Runtime.dll

Overloads

AddByteOffset<T>(T, IntPtr)	Adds a byte offset to the given managed pointer.
AddByteOffset<T>(T, UIntPtr)	Adds a byte offset to the given managed pointer.

AddByteOffset<T>(T, IntPtr)

Source:

Unsafe.cs

Adds a byte offset to the given managed pointer.

C#

public static ref T AddByteOffset<T>(ref T source, IntPtr byteOffset);

Type Parameters

T

The elemental type of the managed pointer.

Parameters

source

T

The managed pointer to add the offset to.

byteOffset

IntPtr

The offset to add.

Returns

T

A new managed pointer that reflects the addition of the specified byte offset to the source pointer.

Remarks

The byteOffset parameter is the number of bytes to add to the source pointer. For example, given a source pointer ptr of type ref int, the call Unsafe.AddByteOffset<int>(ref ptr, 20) will return a new pointer whose address points 20 bytes beyond ptr.

If byteOffset is a calculated value rather than a hardcoded literal, callers should consider the possibility of integer overflow. For example, in the call Unsafe.AddByteOffset<int>(ref ptr, a * b), the caller must ensure the intermediate value a * b does not overflow the bounds of IntPtr.

AddByteOffset<T>(T, UIntPtr)

Source:

Unsafe.cs

Important

This API is not CLS-compliant.

Adds a byte offset to the given managed pointer.

C#

[System.CLSCompliant(false)]
public static ref T AddByteOffset<T>(ref T source, UIntPtr byteOffset);

Type Parameters

T

The elemental type of the managed pointer.

Parameters

source

T

The managed pointer to add the offset to.

byteOffset

nuint

The offset to add.

Returns

T

A new managed pointer that reflects the addition of the specified byte offset to the source pointer.

Attributes

CLSCompliantAttribute

Remarks

The byteOffset parameter is the number of bytes to add to the source pointer. For example, given a source pointer ptr of type ref int, the call Unsafe.AddByteOffset<int>(ref ptr, (nuint)20) will return a new pointer whose address points 20 bytes beyond ptr.

If byteOffset is a calculated value rather than a hardcoded literal, callers should consider the possibility of integer overflow. For example, in the call Unsafe.AddByteOffset<int>(ref ptr, a * b), the caller must ensure the intermediate value a * b does not overflow the bounds of UIntPtr.