_ITERATOR_DEBUG_LEVEL

The _ITERATOR_DEBUG_LEVEL (IDL) macro supersedes and combines the functionality of the _SECURE_SCL (SCL) and _HAS_ITERATOR_DEBUGGING (HID) macros.

Macro Values

The following tables summarize the values for the _SECURE_SCL and _HAS_ITERATOR_DEBUGGING macros, and finally how those values are superseded by the _ITERATOR_DEBUG_LEVEL macro.

The following section describes the possible values of the SCL and HID macros.

  • SCL=0
    Disables checked iterators.

  • SCL=1
    Enables checked iterators.

  • HID=0
    Disables iterator debugging in debug builds.

  • HID=1
    Enables iterator debugging in debug builds. HID cannot be enabled in release builds.

The following table describes how the IDL macro values supersede the SCL and HID macro values.

Compilation mode

New macro

Old macros

Description

Debug

IDL=0

SCL=0, HID=0

Disables checked iterators and disables iterator debugging.

IDL=1

SCL=1, HID=0

Enables checked iterators and disables iterator debugging.

IDL=2 (Default)

SCL=(does not apply), HID=1

By default, enables iterator debugging; checked iterators are not relevant.

Release

IDL=0 (Default)

SCL=0

By default, disables checked iterators.

IDL=1

SCL=1

Enables checked iterators; iterator debugging is not relevant.

Remarks

In release mode, an error is emitted if you specify IDL=2.

Because the _SECURE_SCL and _HAS_ITERATOR_DEBUGGING macros support similar functionality, users are often uncertain which macro and macro value to use in a particular situation. To resolve this issue, we recommend that you use only the _ITERATOR_DEBUG_LEVEL macro.

See Also

Reference

Safe Libraries: C++ Standard Library