Edit

Share via

RtlIntPtrSub function (ntintsafe.h)

  • Article

Subtracts one value of type INT_PTR from another.

Syntax

NTSTATUS RtlIntPtrSub(
  [in]  INT_PTR iMinuend,
  [in]  INT_PTR iSubtrahend,
  [out] INT_PTR *piResult
);

Parameters

[in] iMinuend

The value from which iSubtrahend is subtracted.

[in] iSubtrahend

The value to subtract from iMinuend.

[out] piResult

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.

Requirements

Requirement Value
Target Platform Desktop
Header ntintsafe.h