SetupLogError

[This is preliminary documentation and subject to change.]

The SetupLogError function writes an error message to a log file. It is meant to be used during the installation of Windows NT, but it is always available. It is not intended to be used after Windows NT is installed—the event log should be used instead.

BOOL SetupLogError (
  PCTSTR MessageString,   //String to be saved to log
  LogSeverity Severity    //Severity message
  );

Parameters:

MessageString

Specifies the string that should be saved to Setup's log. It must end with a return-linefeed combination (\r\n). The message is always saved to the action log, setupact.log. If Severity is LogSevWarning, LogSevError, or LogSevFatalError, Setup also saves the message to the error log, setuperr.log. Both logs are stored in the Windows directory.

Severity

Specifies the severity of the message, one of the following : LogSevInformation, LogSevWarning, LogSevError, or LogSevFatalError.

Remarks

• The action log is intended for recording all modifications made to the system during installation of Windows NT.
• The error log is intended for errors during installation of Windows NT only.
• The MessageString parameter may be formatted further by Setup (though it does no additional processing now).
• The error log will be presented to the user at the end of NT setup.

Return Values

If the function succeeds, the return value is a non-zero value.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in setupapi.h.
  Import Library: Link with setupapi.lib.

See Also

Overview, Functions,