IStillImageW::WriteToErrorLog method (sti.h)

Article
10/21/2021

The IStillImage::WriteToErrorLog method writes a message to the still image error log.

Syntax

HRESULT WriteToErrorLog(
       DWORD   dwMessageType,
  [in] LPCWSTR pszMessage
);

Parameters

dwMessageType

Caller-supplied constant value representing the message type. The following values are defined in Sti.h:

STI_TRACE_INFORMATION

STI_TRACE_WARNING

STI_TRACE_ERROR

[in] pszMessage

Caller-supplied pointer to the message string to be written to the log file.

Return value

If the operation succeeds, the method returns S_OK. Otherwise, it returns one of the STIERR-prefixed error codes defined in stierr.h.

Remarks

The still image error log file is named sti_trace.log and is located in the Windows directory. Registry values determine which still image error types (informational, warning, or error) are written to the error log (see Nonmodifiable Registry Entries).

Error messages should be reserved for critical error conditions, such as device hardware failures. Informational messages can be used for your own debugging purposes. Logged messages aren't visible to users, but they might be used by a support engineer to help debug a user's problems.

Before calling IStillImage::WriteToErrorLog, clients of the IStillImage COM interface must call IStillImage::StiCreateInstance to obtain an IStillImage interface pointer.

Requirements

Requirement	Value
Target Platform	Desktop
Header	sti.h (include Sti.h)

Share via