RtlUIntPtrSub function (ntintsafe.h)

Subtracts one value of type UINT_PTR from another.

Syntax

NTSTATUS RtlUIntPtrSub(
  [in]  UINT_PTR uMinuend,
  [in]  UINT_PTR uSubtrahend,
  [out] UINT_PTR *puResult
);

Parameters

[in] uMinuend

The value from which uSubtrahend is subtracted.

[in] uSubtrahend

The value to subtract from uMinuend.

[out] puResult

A pointer to the result. If the operation results in a value that overflows or underflows the capacity of the type, the function returns STATUS_INTEGER_OVERFLOW and this parameter is not valid.

Return value

Returns STATUS_SUCCESS if the operation is successful.

See the implementation of this helper function in ntintsafe.h in the WDK for possible error return values.

Remarks

This is one of a set of inline functions designed to provide arithmetic operations and perform validity checks with minimal impact on performance.

This function uses the following alternate name:

  • RtlUIntPtrSub
  • RtlULongPtrSub
  • RtlDWordPtrSub
  • RtlSIZETSub
  • RtlDWordLongSub
  • RtlULong64Sub
  • RtlDWord64Sub
  • RtlUInt64Sub

Requirements

Requirement Value
Target Platform Desktop
Header ntintsafe.h