WordSub function

  • Article

Subtracts one value of type WORD from another.

Syntax

HRESULT WordSub(
  _In_  WORD wMinuend,
  _In_  WORD wSubtrahend,
  _Out_ WORD *pwResult
);

Parameters

  • wMinuend [in]
    Type: WORD

    The value from which wSubtrahend is subtracted.

  • wSubtrahend [in]
    Type: WORD

    The value to subtract from wMinuend.

  • pwResult [out]
    Type: WORD*

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

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

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

Header

 Intsafe.h