WIAS_ERROR - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers
// wiamdef.h

void WIAS_ERROR(
  x
);
View the official Windows Driver Kit DDI reference
// wiautil.h

void WIAS_ERROR(
  x
);
View the official Windows Driver Kit DDI reference

NtDoc

No description available.

Windows Driver Kit DDI reference (nf-wiamdef-wias_error)

WIAS_ERROR macro (wiamdef.h)

Description

The WIAS_ERROR macro writes a diagnostic message to the Wiatrace.log file.

Parameters

x

Remarks

This macro is the recommended way to implement error logging, because unlike WIAS_LERROR, WIA_ERROR allows error messages to be written to the log file (Wiatrace.log). The utility used to view the contents of this log file is WiaTrcVw.exe.

To enable tracing in free builds, drivers must define the WIA_DEBUG macro by adding #define WIA_DEBUG before including any of the WIA headers. Tracing is enabled by default in checked and debug builds of the operating system.

The following is an example of how the macro can be used:

WIAS_ERROR((g_hInst, "Failed to read (%ws) entry under %ws section of device registry",REG_ENTRY_STORAGEPATH,REG_ENTRY_DEVICEDATA));

This code snippet was taken from Wiadriver.cpp, which is included with the Windows Image Acquisition (WIA) driver samples on GitHub.

See also

WIAS_ASSERT

WIAS_HRESULT

WIAS_TRACE


Windows Driver Kit DDI reference (nf-wiautil-wias_error)

WIAS_ERROR macro (wiautil.h)

Description

The WIAS_ERROR macro writes a diagnostic message to the Wiatrace.log file.

Parameters

x

Remarks

This macro is the recommended way to implement error logging on Windows Vista, because unlike WIAS_LERROR, WIA_ERROR allows error messages to be written to the log file (Wiatrace.log). The Wiatrace.log file is only available in Windows Vista and later versions of the operating system. The utility used to view the contents of this log file is WiaTrcVw.exe.

To enable tracing in free builds, drivers must define the WIA_DEBUG macro by adding #define WIA_DEBUG before including any of the WIA headers. Tracing is enabled by default in checked and debug builds of the operating system.

The following is an example of how the macro can be used:

WIAS_ERROR((g_hInst, "Failed to read (%ws) entry under %ws section of device registry",REG_ENTRY_STORAGEPATH,REG_ENTRY_DEVICEDATA));

This code snippet was taken from Wiadriver.cpp, which is included with the Windows Image Acquisition (WIA) driver samples on GitHub.

See also

WIAS_ASSERT

WIAS_HRESULT

WIAS_TRACE