UIntPtr.Subtract Method (UIntPtr, Int32)

.NET Framework (current version)

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Subtracts an offset from the value of an unsigned pointer.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)

public static UIntPtr Subtract(
	UIntPtr pointer,
	int offset


Type: System.UIntPtr

The unsigned pointer to subtract the offset from.

Type: System.Int32

The offset to subtract.

Return Value

Type: System.UIntPtr

A new unsigned pointer that reflects the subtraction of offset from pointer.

The Subtract method does not throw an exception if the result is too small to represent as a pointer on the specified platform. Instead, the subtraction operation is performed in an unchecked context.

Languages that do not support operator overloading or custom operators can use this method to subtract an offset from the value of an unsigned pointer.

The following example instantiates an IntPtr object that points to the end of a ten-element array, and then calls the Subtract method to iterate the elements in the array in reverse order.

using System;

public class Example
   public static void Main()
      int[] arr = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10};
      UIntPtr ptr = (UIntPtr) arr[arr.GetUpperBound(0)];
      for (int ctr = 0; ctr <= arr.GetUpperBound(0); ctr++)
         UIntPtr newPtr = UIntPtr.Subtract(ptr, ctr);
         Console.Write("{0}   ", newPtr);
// The example displays the following output:
//       10   9   8   7   6   5   4   3   2   1

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top